Start the export of raw data

POST 
/raw-export/report

Start a raw data exportation for experiment or personalization, which will be sent to the given emails.

Request

application/json

Body

required

receiverEmailAddrs string[]
List of receiver email addresses
Example: ["john@kameleoon.com","jane@kameleoon.com"]
id int64required

ID of the experiment or personalization

level stringrequired
Analytics level VISIT/VISITOR
Possible values: [VISIT, VISITOR]
Example: VISIT

dateIntervals

object[]

required

Date interval for the report

Array [

start date-time

end date-time

]

format stringrequired
Format of the report
Possible values: [CSV]
Example: CSV

filters

object[]

Array [

oneOf

AdBlockerFilter1

type stringrequired

include boolean

BrowserFilter1

type stringrequired

values string[]

Possible values: [CHROME, EDGE, FIREFOX, SAFARI, OPERA]

include boolean

browserIntValue int32[]

BrowserLanguageFilter1

type stringrequired

values 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 boolean

languageCodes string[]

ConversionsFilter1

type stringrequired

values int64[]

include boolean

CustomDataFilter1

type stringrequired

include boolean

customDataId int64

value string

DayFilter

type stringrequired

include boolean

DeviceTypeFilter1

type stringrequired

values string[]

Possible values: [DESKTOP, TABLET, PHONE]

include boolean

ExperimentDataFilter1

type stringrequired

id int64

variationIds int64[]

include boolean

FirstReferrerFilter1

type stringrequired

values int32[]

include boolean

valuesAsString string[]

KeyPageFilter

type stringrequired

include boolean

values int32[]

LandingPageURLFilter1

type stringrequired

values string[]

include boolean

NewVisitorFilter

type stringrequired

visitorsType string

Possible values: [NEW_VISITORS, RETURNING_VISITORS]

NumberPagesFilter2

type stringrequired

values

object[]

Array [

param string

Possible values: [GREATER, LOWER, EQUAL, BETWEEN]

value int32

unit string

Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

]

include boolean

NumberVisitsFilter1

type stringrequired

values

object[]

Array [

param string

Possible values: [GREATER, LOWER, EQUAL, BETWEEN]

value int32

unit string

Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

]

include boolean

OperatingSystemFilter1

type stringrequired

values string[]

Possible values: [WINDOWS, MAC_OS, I_OS, LINUX, ANDROID, WINDOWS_PHONE]

include boolean

operatingSystemAsInteger int32[]

PageTitleFilter1

type stringrequired

values string[]

include boolean

PageURLFilter1

type stringrequired

values string[]

include boolean

PersonalizationDataFilter1

type stringrequired

id int64

exposition string

Possible values: [ALL, EXPOSED, NOT_EXPOSED]

include boolean

ReferrerURLFilter1

type stringrequired

values string[]

include boolean

SdkFilter1

type stringrequired

include boolean

values string[]

Possible values: [JAVA, ANDROID, GO, DOTNET, PYTHON, RUBY, IOS, PHP, JAVASCRIPT, NODEJS, REACT, RUST]

SinceLastVisitFilter1

type stringrequired

values

object[]

Array [

param string

Possible values: [GREATER, LOWER, EQUAL, BETWEEN]

value int32

unit string

Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

]

include boolean

TargetingSegmentFilter1

type stringrequired

values int64[]

include boolean

TemperatureFilter2

type stringrequired

include boolean

param string

Possible values: [GREATER, LOWER, EQUAL, BETWEEN]

from int32

to int32

TimeSlotFilter1

type stringrequired

include boolean

visitorCalendar boolean

values array[]

ranges

object

property name*

ImmutableTripleIntegerIntegerInteger

left int32

middle int32

right int32

TimeSpentFilter1

type stringrequired

values

object[]

Array [

param string

Possible values: [GREATER, LOWER, EQUAL, BETWEEN]

value int32

unit string

Possible values: [SECONDS, MINUTES, HOURS, DAYS, WEEKS]

]

include boolean

TrafficFilter2

type stringrequired

values string[]

Possible values: [SEO, SEM, AFFILIATION, EMAIL, DIRECT]

include boolean

WeatherFilter1

type stringrequired

values string[]

Possible values: [CLEAR_SKY, CLOUDS, RAIN, THUNDERSTORM, SNOW, HAIL, WIND, ATMOSPHERIC_DISTURBANCES]

include boolean

weatherAsString string[]

WeekdayFilter1

type stringrequired

values string[]

Possible values: [SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY]

include boolean

visitorCalendar boolean

intValues int32[]

]

actionType stringrequired
Action type of the report
Possible values: [EXPERIMENT, PERSONALIZATION]
Example: EXPERIMENT
customDataIds int64[]

Custom data to export

conversionType stringrequired

Type of the conversion, we have two options ALL_CONVERSION and CONVERTED_VISITS

Possible values: [ALL_CONVERSION, CONVERTED_VISITS]

Responses

200

Report export started successfully.

*/*

Schema

Schema

id int64
msg string

Example (from schema)

{
  "id": 0,
  "msg": "string"
}

204

No data match your request.

400

Invalid input parameters or status.

*/*

Schema

Schema

id int64
msg string

Example (from schema)

{
  "id": 0,
  "msg": "string"
}

402

Export not allowed due to plan limitations.

*/*

Schema

Schema

id int64
msg string

Example (from schema)

{
  "id": 0,
  "msg": "string"
}

500

Internal Server Error

*/*

Schema

Schema

serviceName string
message string

Example (from schema)

{
  "serviceName": "string",
  "message": "string"
}

Loading...