Export experiment results
Initiates results export for a given campaign and params. Returns data hash code that should be used for checking request status and obtaining file with results.
Path Parameters
- experimentId int64 required
- application/json
Request Body required
- allVariationsData boolean
Default value:
false
Set to true to include data from all variations at once.
- bayesian boolean
Default value:
false
Enables the current Bayesian result probability for the experiment in the report.
breakdown object
- oneOf
- Breakdown
- CrossCampaignBreakdownIO
- CustomDatumBreakdownIO
- IntervalBreakdownIO
type stringPossible values: [
BROWSER
,CUSTOM_DATUM
,DEVICE_TYPE
,NEW_VISITOR
,GOAL_REACHED
,PAGE_URL
,FIRST_REFERRER
,ORIGIN_TYPE
,OS
,PAGE_TITLE
,NUMBER_PAGES
,LANDING_PAGE_URL
,AD_BLOCKER
,DAY_OF_WEEK
,DAYS_OF_WEEK
,VISIT_DURATION
,WEATHER_CODE
,DAY
,TEMPERATURE
,NUMBER_VISITS
,FIRST_REFERRER_URL
,KEY_PAGE
,TARGETING_SEGMENT
,TIME_SINCE_PREVIOUS_VISIT
,KEYWORD
,COUNTRY
,REGION
,CITY
,LANGUAGE
,JAVA_ENABLED
,LANDING_PAGE
,TIME_ZONE_GROUP
,SCREEN_WIDTH
,SCREEN_HEIGHT
,SCREEN_RESOLUTION
,REFERRER
,TIME_ZONE_ID
,LOCALE_LANGUAGE_CODE
,LOCALE_COUNTRY_CODE
,LOCALE_LANGUAGE_TAG
,PERSONALIZATION_UNEXPOSITION_CAUSE
,CROSS_CAMPAIGN
,SDK
,SDK_VERSION
,INTERVAL
]Type of breakdown. Types CUSTOM_DATUM and CROSS_CAMPAIGN have additional fields.
type stringPossible values: [
BROWSER
,CUSTOM_DATUM
,DEVICE_TYPE
,NEW_VISITOR
,GOAL_REACHED
,PAGE_URL
,FIRST_REFERRER
,ORIGIN_TYPE
,OS
,PAGE_TITLE
,NUMBER_PAGES
,LANDING_PAGE_URL
,AD_BLOCKER
,DAY_OF_WEEK
,DAYS_OF_WEEK
,VISIT_DURATION
,WEATHER_CODE
,DAY
,TEMPERATURE
,NUMBER_VISITS
,FIRST_REFERRER_URL
,KEY_PAGE
,TARGETING_SEGMENT
,TIME_SINCE_PREVIOUS_VISIT
,KEYWORD
,COUNTRY
,REGION
,CITY
,LANGUAGE
,JAVA_ENABLED
,LANDING_PAGE
,TIME_ZONE_GROUP
,SCREEN_WIDTH
,SCREEN_HEIGHT
,SCREEN_RESOLUTION
,REFERRER
,TIME_ZONE_ID
,LOCALE_LANGUAGE_CODE
,LOCALE_COUNTRY_CODE
,LOCALE_LANGUAGE_TAG
,PERSONALIZATION_UNEXPOSITION_CAUSE
,CROSS_CAMPAIGN
,SDK
,SDK_VERSION
,INTERVAL
]Type of breakdown. Types CUSTOM_DATUM and CROSS_CAMPAIGN have additional fields.
experiments int32[]Experiment IDs of the experiments to use to segment the data. Could be empty if personalizations field is specified.
personalizations int32[]Personalization IDs of the personalizations to use to segment the data. Could be empty if experiments field is specified.
type stringPossible values: [
BROWSER
,CUSTOM_DATUM
,DEVICE_TYPE
,NEW_VISITOR
,GOAL_REACHED
,PAGE_URL
,FIRST_REFERRER
,ORIGIN_TYPE
,OS
,PAGE_TITLE
,NUMBER_PAGES
,LANDING_PAGE_URL
,AD_BLOCKER
,DAY_OF_WEEK
,DAYS_OF_WEEK
,VISIT_DURATION
,WEATHER_CODE
,DAY
,TEMPERATURE
,NUMBER_VISITS
,FIRST_REFERRER_URL
,KEY_PAGE
,TARGETING_SEGMENT
,TIME_SINCE_PREVIOUS_VISIT
,KEYWORD
,COUNTRY
,REGION
,CITY
,LANGUAGE
,JAVA_ENABLED
,LANDING_PAGE
,TIME_ZONE_GROUP
,SCREEN_WIDTH
,SCREEN_HEIGHT
,SCREEN_RESOLUTION
,REFERRER
,TIME_ZONE_ID
,LOCALE_LANGUAGE_CODE
,LOCALE_COUNTRY_CODE
,LOCALE_LANGUAGE_TAG
,PERSONALIZATION_UNEXPOSITION_CAUSE
,CROSS_CAMPAIGN
,SDK
,SDK_VERSION
,INTERVAL
]Type of breakdown. Types CUSTOM_DATUM and CROSS_CAMPAIGN have additional fields.
index int32The index of the custom data to use to segment the data.
type stringPossible values: [
BROWSER
,CUSTOM_DATUM
,DEVICE_TYPE
,NEW_VISITOR
,GOAL_REACHED
,PAGE_URL
,FIRST_REFERRER
,ORIGIN_TYPE
,OS
,PAGE_TITLE
,NUMBER_PAGES
,LANDING_PAGE_URL
,AD_BLOCKER
,DAY_OF_WEEK
,DAYS_OF_WEEK
,VISIT_DURATION
,WEATHER_CODE
,DAY
,TEMPERATURE
,NUMBER_VISITS
,FIRST_REFERRER_URL
,KEY_PAGE
,TARGETING_SEGMENT
,TIME_SINCE_PREVIOUS_VISIT
,KEYWORD
,COUNTRY
,REGION
,CITY
,LANGUAGE
,JAVA_ENABLED
,LANDING_PAGE
,TIME_ZONE_GROUP
,SCREEN_WIDTH
,SCREEN_HEIGHT
,SCREEN_RESOLUTION
,REFERRER
,TIME_ZONE_ID
,LOCALE_LANGUAGE_CODE
,LOCALE_COUNTRY_CODE
,LOCALE_LANGUAGE_TAG
,PERSONALIZATION_UNEXPOSITION_CAUSE
,CROSS_CAMPAIGN
,SDK
,SDK_VERSION
,INTERVAL
]Type of breakdown. Types CUSTOM_DATUM and CROSS_CAMPAIGN have additional fields.
interval stringPossible values: [
HOUR
,DAY
,WEEK
,MONTH
,YEAR
]Date interval type to use to segment the data. Possible values: HOUR, DAY, WEEK, MONTH, YEAR
- oneOf
- callbackUrl string
Callback URL that you want to send the data response to.
dateIntervals object[] required
Date boundaries to include only the results from the specified time period(s).
Array [end date-timeEnd timestamp
start date-timeStart timestamp
]exportOptions object
Options for XLSX/PDF exportation.
columns string[]Possible values: [
VISITS
,VISITORS
,VISITS_CONVERTED
,VISITORS_CONVERTED
,ALL_CONVERSIONS
,CONVERSION_RATE_VISITS
,IMPROVEMENT_RATE_VISITS
,RELIABILITY_RATE_VISITS
,CONVERSION_RATE_VISITORS
,IMPROVEMENT_RATE_VISITORS
,RELIABILITY_RATE_VISITORS
,CONVERSION_RATE_ALL_VISITS
,IMPROVEMENT_RATE_ALL_VISITS
,CONVERSION_RATE_ALL_VISITORS
,IMPROVEMENT_RATE_ALL_VISITORS
,BAYESIAN_RELIABILITY_RATE_VISITS
,BAYESIAN_RELIABILITY_RATE_VISITORS
,REVENUE
,AVERAGE_CART_VISITS
,AVERAGE_CART_VISITORS
,CONVERSION_RATE_CUPED
,RELIABILITY_RATE_CUPED
,RELIABILITY_RATE_SEQUENTIAL
,IMPROVEMENT_RANGE_SEQUENTIAL
,IMPROVEMENT_RANGE_DEFAULT
,IMPROVEMENT_RANGE_CUPED
,IMPROVEMENT_RATE_CUPED
,CONVERSION_RATE_MULTIPLE_TESTING
,RELIABILITY_RATE_MULTIPLE_TESTING
,IMPROVEMENT_RATE_MULTIPLE_TESTING
]Columns for XLS export
filterLabels string[]format stringPossible values: [
XLSX
,PDF
]Format that you want to export the report data to.
view stringPossible values: [
PER_GOAL
,PER_VARIATION
,PER_AUDIENCE
,ALL_IN_ONE
]Type of data view for XLS. Result data will be arranged and broken down depending on this parameter
filters object[]
List of filters to apply to the data included in the report.
Array [- oneOf
- AdBlockerFilter
- BrowserFilter
- BrowserLanguageFilter
- ConversionsFilter
- CustomDataFilter
- DayFilter
- DeviceTypeFilter
- ExperimentDataFilter
- FirstReferrerFilter
- KeyPageFilter
- LandingPageURLFilter
- NewVisitorFilter
- NumberPagesFilter
- NumberVisitsFilter
- OperatingSystemFilter
- PageTitleFilter
- PageURLFilter
- PersonalizationDataFilter
- ReferrerURLFilter
- SdkFilter
- SinceLastVisitFilter
- TargetingSegmentFilter
- TemperatureFilter
- TimeSlotFilter
- TimeSpentFilter
- TrafficFilter
- WeatherFilter
- WeekdayFilter
include booleaninclude booleanvalues string[]Possible values: [
CHROME
,EDGE
,FIREFOX
,SAFARI
,OPERA
]include booleanvalues string[]Possible values: [
AB
,AA
,AF
,AK
,SQ
,AM
,AR
,AN
,HY
,AS
,AV
,AE
,AY
,AZ
,BM
,BA
,EU
,BE
,BN
,BH
,BI
,BS
,BR
,BG
,MY
,CA
,CH
,CE
,NY
,ZH
,CV
,KW
,CO
,CR
,HR
,CS
,DA
,DV
,NL
,DZ
,EN
,EO
,ET
,EE
,FO
,FJ
,FI
,FR
,FF
,GL
,KA
,DE
,EL
,GN
,GU
,HT
,HA
,HE
,HZ
,HI
,HO
,HU
,IA
,ID
,IE
,GA
,IG
,IK
,IO
,IS
,IT
,IU
,JA
,JV
,KL
,KN
,KR
,KS
,KK
,KM
,KI
,RW
,KY
,KV
,KG
,KO
,KU
,KJ
,LA
,LB
,LG
,LI
,LN
,LO
,LT
,LU
,LV
,GV
,MK
,MG
,MS
,ML
,MT
,MI
,MR
,MH
,MN
,NA
,NV
,ND
,NE
,NG
,NB
,NN
,NO
,II
,NR
,OC
,OJ
,CU
,OM
,OR
,OS
,PA
,PI
,FA
,PL
,PS
,PT
,QU
,RM
,RN
,RO
,RU
,SA
,SC
,SD
,SE
,SM
,SG
,SR
,GD
,SN
,SI
,SK
,SL
,SO
,ST
,ES
,SU
,SW
,SS
,SV
,TA
,TE
,TG
,TH
,TI
,BO
,TK
,TL
,TN
,TO
,TR
,TS
,TT
,TW
,TY
,UG
,UK
,UR
,UZ
,VE
,VI
,VO
,WA
,CY
,WO
,FY
,XH
,YI
,YO
,ZA
,ZU
]include booleanvalues int64[]customDataId int64include booleanvalue stringinclude booleaninclude booleanvalues string[]Possible values: [
DESKTOP
,TABLET
,PHONE
]id int64include booleanvariationIds int64[]include booleanvalues int32[]include booleanvalues int32[]include booleanvalues string[]visitorsType stringPossible values: [
NEW_VISITORS
,RETURNING_VISITORS
]include booleanvalues object[]
Array [param stringPossible values: [
GREATER
,LOWER
,EQUAL
,BETWEEN
]value int32unit stringPossible values: [
SECONDS
,MINUTES
,HOURS
,DAYS
,WEEKS
]]include booleanvalues object[]
Array [param stringPossible values: [
GREATER
,LOWER
,EQUAL
,BETWEEN
]value int32unit stringPossible values: [
SECONDS
,MINUTES
,HOURS
,DAYS
,WEEKS
]]include booleanvalues string[]Possible values: [
WINDOWS
,MAC_OS
,I_OS
,LINUX
,ANDROID
,WINDOWS_PHONE
]include booleanvalues string[]include booleanvalues string[]exposition stringPossible values: [
ALL
,EXPOSED
,NOT_EXPOSED
]id int64include booleaninclude booleanvalues string[]include booleanvalues string[]Possible values: [
JAVA
,ANDROID
,GO
,DOTNET
,PYTHON
,RUBY
,IOS
,PHP
,JAVASCRIPT
,NODEJS
,REACT
,RUST
]include booleanvalues object[]
Array [param stringPossible values: [
GREATER
,LOWER
,EQUAL
,BETWEEN
]value int32unit stringPossible values: [
SECONDS
,MINUTES
,HOURS
,DAYS
,WEEKS
]]include booleanvalues int64[]from int32include booleanparam stringPossible values: [
GREATER
,LOWER
,EQUAL
,BETWEEN
]to int32include booleanvalues array[]visitorCalendar booleaninclude booleanvalues object[]
Array [param stringPossible values: [
GREATER
,LOWER
,EQUAL
,BETWEEN
]value int32unit stringPossible values: [
SECONDS
,MINUTES
,HOURS
,DAYS
,WEEKS
]]include booleanvalues string[]Possible values: [
SEO
,DIRECT
,SEM
,EMAIL
,AFFILIATION
]include booleanvalues string[]Possible values: [
CLEAR_SKY
,CLOUDS
,RAIN
,THUNDERSTORM
,SNOW
,HAIL
,WIND
,ATMOSPHERIC_DISTURBANCES
]include booleanvalues string[]Possible values: [
SUNDAY
,MONDAY
,TUESDAY
,WEDNESDAY
,THURSDAY
,FRIDAY
,SATURDAY
]visitorCalendar boolean]- goalIdsCuped int64[]
Specifies which CUPED goals to include in the report. Use an empty list [] to exclude all CUPED goals. Use null to include all CUPED goals. Use a list of CUPED goal IDs [123, 456] to include only those goals.
- goalsIds int64[]
Specifies which goals to include in the report. Use an empty list [] to exclude all goals. Use null to include all goals. Use a list of goal IDs [123, 456] to include only those goals.
- interval string deprecated
Possible values: [
HOUR
,DAY
,WEEK
,MONTH
,YEAR
]Time interval for which data is segmented in the report. Deprecated. Use breakdown with IntervalBreakdown type instead.
- referenceVariationId string
Unique ID of the variation that you want to use as the reference variation.
- sequentialTesting boolean
Default value:
false
Enables the sequential testing result for the experiment in the report.
- visitorData boolean
Default value:
false
Set to true to only include data from unique visitors. By default, the report includes all visitor data.
- 200
- 400
- 403
- 423
- 500
- 503
OK
- */*
- Schema
- Example (from schema)
Schema
- dataCode string
{
"dataCode": "string"
}
Bad Request
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-30T16:33:49.528Z"
}
Forbidden
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-30T16:33:49.528Z"
}
Locked
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-30T16:33:49.528Z"
}
Internal Server Error
- */*
- Schema
- Example (from schema)
Schema
- code string
- impersonator string
- message string
- name string
- status string
Possible values: [
SUCCESS
,ERROR
] - sub string
- time int64
- timestamp date-time
{
"code": "string",
"impersonator": "string",
"message": "string",
"name": "string",
"status": "SUCCESS",
"sub": "string",
"time": 0,
"timestamp": "2024-04-30T16:33:49.528Z"
}
Service Unavailable
- */*
- Schema
- Example (from schema)
Schema
- object
{}