\n | Field | Header | Format | Availability |
\n | actionlog_id | EA internal ID | Unsigned int | Always |
\n | actionlog_datein | Date at which the goal was initiated | DMYHMS date | Always |
\n | actionlog_datein_dmy | Date at which the goal was initiated | DMY date | with-date-dmy=1 |
\n | actionlog_datein_hms | Date at which the goal was initiated | HMS date | with-date-hms=1 |
\n | actionlog_datein_epoch | Date at which the goal was initiated | Epoch UNIX | with-date-epoch=1 |
\n | actionlog_dateout | Date at which the goal was finalized | DMYHMS date | Always |
\n | actionlog_dateout_dmy | Date at which the goal was finalized | DMY date | with-date-dmy=1 |
\n | actionlog_dateout_hms | Date at which the goal was finalized | HMS date | with-date-hms=1 |
\n | actionlog_dateout_epoch | Date at which the goal was finalized | Epoch UNIX | with-date-epoch=1 |
\n | actionlog_ref | Goal reference | Text | Always |
\n | action_name | Goal name | Text | with-actionname=1 |
\n | email_id | Email address | Text | with-email=1 |
\n | actiolog_extparam | External parameter | Text | with-extparam=1 |
\n | actionlog_buyerid | BuyerId | Signed int | with-buyerid=1 |
\n | iduser_fullid | CRM ID | Text | with-userid=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvl0_pX | Field PX of the channel on level 0 | Text | with-channel-level=1&max-channel-level=1 |
\n | channel_lvl0_pX | Field PX of the channel on level 1 | Text | with-channel-level=1&max-channel-level=2 |
\n | channel_lvl0_pX | Field PX of the channel on level 2 | Text | with-channel-level=1&max-channel-level=3 |
\n | channel_lvlX_P0 | Field P0 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel on level X | Text | with-channel-level=1&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel on level X | Text | with-channel-level=1&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 of the channel on level X | Text | with-channel-level=1&max-channel-info=4 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | &with-channel-date=1&view-id=ID_VIEW |
\n | a_actionlogpage_sz | Number of pages associated with the goal | Total | with-actionlogpage=1 |
\n | actionlogpage_name_X: X being the page index | Name of the page | Text | with-actionlogpage=1 |
\n | a_actionparam_sz | Number of params associated to the goal | Total | with-actionparam=1 |
\n | actionparam_name_$NAME | Name of the param linked to the goal | Text | with-actionparam=1 |
\n | rp_last_31 | Last cross-device Apple IDFA | Text | with-last-rp-ea-ios-idfa=1 |
\n | rp_last_32 | Last cross-device Google ADID | Text | with-last-rp-ea-android-adid=1 |
\n
\n",
"operationId" : "downloadDatamining:goals",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as a CSV file.",
"example" : 1,
"in" : "query",
"name" : "output-as-csv",
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as an array of key/value fields.",
"example" : 1,
"in" : "query",
"name" : "output-as-kv",
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "actionlog_ref"
}
],
"rows" : [
[
"REF-ACTIONLOG-1777564990"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Download the report",
"tags" : [
"Datamining: goals"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990&output-as-csv=1&output-as-kv=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/download.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/actionlog/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.\n\nPlease check the following [section](#section/Introduction/Asynchronous-calls) for more information about the download process.",
"operationId" : "searchDatamining:goals",
"parameters" : [
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/15/2018",
"in" : "query",
"name" : "date-from",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/29/2018",
"in" : "query",
"name" : "date-to",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "set this flag to 1 if you want the dates to be formatted according to a preset format, otherwise you will always have epoch format times.",
"example" : 1,
"in" : "query",
"name" : "ea-enable-datefmt",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Column: Label 1",
"example" : 1,
"in" : "query",
"name" : "with-actionlabel1",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Label 2",
"example" : 1,
"in" : "query",
"name" : "with-actionlabel2",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Label 3",
"example" : 1,
"in" : "query",
"name" : "with-actionlabel3",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Label 4",
"example" : 1,
"in" : "query",
"name" : "with-actionlabel4",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Label 5",
"example" : 1,
"in" : "query",
"name" : "with-actionlabel5",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: number of pages",
"example" : 1,
"in" : "query",
"name" : "with-actionlogpage",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: goal parameters",
"example" : 1,
"in" : "query",
"name" : "with-actionparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Eulerian identifier (EUID)",
"example" : 1,
"in" : "query",
"name" : "with-buyerid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CGI params",
"example" : 1,
"in" : "query",
"name" : "with-cgiparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: total number of interactions",
"example" : 1,
"in" : "query",
"name" : "with-channel-count",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: interaction date per channel",
"example" : 1,
"in" : "query",
"name" : "with-channel-date",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: level of detail of the marketing channels",
"example" : 1,
"in" : "query",
"name" : "with-channel-level",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Interaction type (post-clic/post-impression/revisit)",
"example" : 1,
"in" : "query",
"name" : "with-channel-via",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: entry date (MM/DD/YYYY)",
"example" : 1,
"in" : "query",
"name" : "with-date-dmy",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: entry date (epoch)",
"example" : 1,
"in" : "query",
"name" : "with-date-epoch",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: entry date (HH :MM :SS)",
"example" : 1,
"in" : "query",
"name" : "with-date-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: email",
"example" : 1,
"in" : "query",
"name" : "with-email",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: external parameter",
"example" : 1,
"in" : "query",
"name" : "with-extparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: last Android ID",
"example" : 1,
"in" : "query",
"name" : "with-last-rp-ea-android-adid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: last iOS IDFA",
"example" : 1,
"in" : "query",
"name" : "with-last-rp-ea-ios-idfa",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CRM identifier (UID)",
"example" : 1,
"in" : "query",
"name" : "with-userid",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Datamining: goals"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/search.json?date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-actionlabel1=1&with-actionlabel2=1&with-actionlabel3=1&with-actionlabel4=1&with-actionlabel5=1&with-actionlogpage=1&with-actionparam=1&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-email=1&with-extparam=1&with-last-rp-ea-android-adid=1&with-last-rp-ea-ios-idfa=1&with-userid=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-actionlabel1=1&with-actionlabel2=1&with-actionlabel3=1&with-actionlabel4=1&with-actionlabel5=1&with-actionlogpage=1&with-actionparam=1&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-email=1&with-extparam=1&with-last-rp-ea-android-adid=1&with-last-rp-ea-ios-idfa=1&with-userid=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-actionlabel1=1&with-actionlabel2=1&with-actionlabel3=1&with-actionlabel4=1&with-actionlabel5=1&with-actionlogpage=1&with-actionparam=1&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-email=1&with-extparam=1&with-last-rp-ea-android-adid=1&with-last-rp-ea-ios-idfa=1&with-userid=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-actionlabel1=1&with-actionlabel2=1&with-actionlabel3=1&with-actionlabel4=1&with-actionlabel5=1&with-actionlogpage=1&with-actionparam=1&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-email=1&with-extparam=1&with-last-rp-ea-android-adid=1&with-last-rp-ea-ios-idfa=1&with-userid=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/actionlog/status.json" : {
"get" : {
"description" : "When sending a `search` request, you can check the generation status of the report by querying this method.",
"operationId" : "statusDatamining:goals",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_status"
}
],
"rows" : [
[
"INPROGRESS"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the generation status.",
"tags" : [
"Datamining: goals"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/status.json?jobrun-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/status.json?jobrun-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/status.json?jobrun-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/actionlog/status.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/dimensions.json" : {
"get" : {
"description" : "Given a ``path`` get all the available dimensions.",
"operationId" : "dimensionsBatchReporting",
"parameters" : [
{
"description" : "the path for which you want the available dimensions.",
"example" : "mcMEDIAINCOMING[35].mcMEDIAAD",
"in" : "query",
"name" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "field"
},
{
"name" : "name"
}
],
"rows" : [
[
"media_key",
"Media Key"
],
[
"media_id",
"Media Id"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 2
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Available dimensions",
"tags" : [
"Batch Reporting"
],
"x-MCP-resource" : {
"uri" : "eulerian://reporting/batch/dimensions?site={site}&path={path}"
},
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/dimensions.json?path=mcMEDIAINCOMING%5B35%5D.mcMEDIAAD\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/dimensions.json?path=mcMEDIAINCOMING[35].mcMEDIAAD',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/dimensions.json?path=mcMEDIAINCOMING[35].mcMEDIAAD');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'path=mcMEDIAINCOMING%5B35%5D.mcMEDIAAD'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/dimensions.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/download.json" : {
"get" : {
"description" : "Once the report is available (status is `COMPLETED`) you can download the data by querying this method.\n\n\nDepending on the **kind** of the report, check specific documentation on data available in the report, supported kinds are :\n* `cj#report-name` to request [Customer Journey](#tag/Customer-Journey) type of reports.\n* `rt#report-name` to request Real-time Analytics type of reports.",
"operationId" : "downloadBatchReporting",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `query`",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Download",
"tags" : [
"Batch Reporting"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/download.json?jobrun-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/download.json?jobrun-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/download.json?jobrun-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/download.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/kinds.json" : {
"get" : {
"description" : "Return the available ``kinds`` to be used with the Report API.",
"operationId" : "kindsBatchReporting",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "kind"
},
{
"name" : "name"
}
],
"rows" : [
[
"rt#insummary",
"Synthese globale"
],
[
"rt#pagetree",
"Rapport des pages"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 2
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Available kinds",
"tags" : [
"Batch Reporting"
],
"x-MCP-resource" : {
"uri" : "eulerian://reporting/batch/kinds?site={site}"
},
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/kinds.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/kinds.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/kinds.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/kinds.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/metrics.json" : {
"get" : {
"description" : "Given a ``kind`` return the available metrics.",
"operationId" : "metricsBatchReporting",
"parameters" : [
{
"description" : "the kind of datasource for which you want the available metrics.",
"example" : "rt#insummary",
"in" : "query",
"name" : "kind",
"required" : true,
"schema" : {
"enum" : [
"rt#action",
"rt#actionparam",
"rt#actionparamvalue",
"rt#blockpromo",
"rt#browser",
"rt#cgiparam",
"rt#cluster",
"rt#clustervalue",
"rt#creative",
"rt#dataconnector",
"rt#dataconnectorcm",
"rt#devicebrowser",
"rt#devicehardware",
"rt#deviceplatform",
"rt#devicescreeninches",
"rt#devicetype",
"rt#dewebsite",
"rt#ebmdbreq",
"rt#event",
"rt#flash",
"rt#geoloc",
"rt#geoloccity",
"rt#geolocregion",
"rt#headingtree",
"rt#headingtreeentry",
"rt#headingtreeexit",
"rt#iduserparam",
"rt#iduserparamvalue",
"rt#inadvertising",
"rt#inaffiliation",
"rt#inaudience",
"rt#inbranding",
"rt#ingeneric",
"rt#inmailing",
"rt#inpaidinclusion",
"rt#inpartner",
"rt#inproduct",
"rt#inreferer",
"rt#insearchengine",
"rt#insegment",
"rt#insocial",
"rt#insponsoredlink",
"rt#insummary",
"rt#intrustedfeed",
"rt#isengine",
"rt#isp",
"rt#landing",
"rt#lang",
"rt#location",
"rt#mediaplan",
"rt#ope",
"rt#opesubmedia",
"rt#os",
"rt#pagegroup",
"rt#pagetree",
"rt#pagetreeentry",
"rt#pagetreeerror",
"rt#pagetreeexit",
"rt#productevent",
"rt#profilechange",
"rt#publisher",
"rt#redirectdomainaccess",
"rt#rootpublishercluster",
"rt#sdepth",
"rt#ssize",
"rt#sslcipher",
"rt#sslversion",
"rt#tagmaster",
"rt#website"
],
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "field"
},
{
"name" : "name"
},
{
"name" : "affinity"
}
],
"rows" : [
[
"click",
"inbound clicks",
"int"
],
[
"clicksession_viewsession",
"clicks/impressions (session)",
"pct"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 2
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Available metrics",
"tags" : [
"Batch Reporting"
],
"x-MCP-resource" : {
"uri" : "eulerian://reporting/batch/metrics?site={site}&kind={kind}"
},
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics.json?kind=rt%23insummary\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics.json?kind=rt#insummary',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics.json?kind=rt#insummary');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'kind=rt%23insummary'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/metrics_info.json" : {
"get" : {
"description" : "Given a ``kind`` and a ``metric``, return detailed information about it.",
"operationId" : "metricsInfoBatchReporting",
"parameters" : [
{
"description" : "Language in which you want the descriptions.",
"example" : "fr",
"in" : "query",
"name" : "ea-lg",
"schema" : {
"enum" : [
"fr",
"en",
"es",
"de",
"it"
],
"type" : "string"
}
},
{
"description" : "the kind of datasource for which you want the available metrics.",
"example" : "rt#insummary",
"in" : "query",
"name" : "kind",
"required" : true,
"schema" : {
"enum" : [
"rt#action",
"rt#actionparam",
"rt#actionparamvalue",
"rt#blockpromo",
"rt#browser",
"rt#cgiparam",
"rt#cluster",
"rt#clustervalue",
"rt#creative",
"rt#dataconnector",
"rt#dataconnectorcm",
"rt#devicebrowser",
"rt#devicehardware",
"rt#deviceplatform",
"rt#devicescreeninches",
"rt#devicetype",
"rt#dewebsite",
"rt#ebmdbreq",
"rt#event",
"rt#flash",
"rt#geoloc",
"rt#geoloccity",
"rt#geolocregion",
"rt#headingtree",
"rt#headingtreeentry",
"rt#headingtreeexit",
"rt#iduserparam",
"rt#iduserparamvalue",
"rt#inadvertising",
"rt#inaffiliation",
"rt#inaudience",
"rt#inbranding",
"rt#ingeneric",
"rt#inmailing",
"rt#inpaidinclusion",
"rt#inpartner",
"rt#inproduct",
"rt#inreferer",
"rt#insearchengine",
"rt#insegment",
"rt#insocial",
"rt#insponsoredlink",
"rt#insummary",
"rt#intrustedfeed",
"rt#isengine",
"rt#isp",
"rt#landing",
"rt#lang",
"rt#location",
"rt#mediaplan",
"rt#ope",
"rt#opesubmedia",
"rt#os",
"rt#pagegroup",
"rt#pagetree",
"rt#pagetreeentry",
"rt#pagetreeerror",
"rt#pagetreeexit",
"rt#productevent",
"rt#profilechange",
"rt#publisher",
"rt#redirectdomainaccess",
"rt#rootpublishercluster",
"rt#sdepth",
"rt#ssize",
"rt#sslcipher",
"rt#sslversion",
"rt#tagmaster",
"rt#website"
],
"type" : "string"
}
},
{
"description" : "Metric for which you want the detailed information.",
"example" : "visit",
"in" : "query",
"name" : "metric",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Information about a given metric",
"tags" : [
"Batch Reporting"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_info.json?ea-lg=fr&kind=rt%23insummary&metric=visit\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_info.json?ea-lg=fr&kind=rt#insummary&metric=visit',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_info.json?ea-lg=fr&kind=rt#insummary&metric=visit');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'ea-lg=fr&kind=rt%23insummary&metric=visit'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_info.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/metrics_segments.json" : {
"get" : {
"description" : "Given a ``kind`` and dates, return the list of segments available for segmenting metrics.",
"operationId" : "metricsSegmentsBatchReporting",
"parameters" : [
{
"description" : "From date",
"example" : "DD/MM/YYYY",
"in" : "query",
"name" : "date-from",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "To date",
"example" : "DD/MM/YYYY",
"in" : "query",
"name" : "date-to",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the kind of datasource for which you want the available metrics.",
"example" : "rt#insummary",
"in" : "query",
"name" : "kind",
"required" : true,
"schema" : {
"enum" : [
"rt#action",
"rt#actionparam",
"rt#actionparamvalue",
"rt#blockpromo",
"rt#browser",
"rt#cgiparam",
"rt#cluster",
"rt#clustervalue",
"rt#creative",
"rt#dataconnector",
"rt#dataconnectorcm",
"rt#devicebrowser",
"rt#devicehardware",
"rt#deviceplatform",
"rt#devicescreeninches",
"rt#devicetype",
"rt#dewebsite",
"rt#ebmdbreq",
"rt#event",
"rt#flash",
"rt#geoloc",
"rt#geoloccity",
"rt#geolocregion",
"rt#headingtree",
"rt#headingtreeentry",
"rt#headingtreeexit",
"rt#iduserparam",
"rt#iduserparamvalue",
"rt#inadvertising",
"rt#inaffiliation",
"rt#inaudience",
"rt#inbranding",
"rt#ingeneric",
"rt#inmailing",
"rt#inpaidinclusion",
"rt#inpartner",
"rt#inproduct",
"rt#inreferer",
"rt#insearchengine",
"rt#insegment",
"rt#insocial",
"rt#insponsoredlink",
"rt#insummary",
"rt#intrustedfeed",
"rt#isengine",
"rt#isp",
"rt#landing",
"rt#lang",
"rt#location",
"rt#mediaplan",
"rt#ope",
"rt#opesubmedia",
"rt#os",
"rt#pagegroup",
"rt#pagetree",
"rt#pagetreeentry",
"rt#pagetreeerror",
"rt#pagetreeexit",
"rt#productevent",
"rt#profilechange",
"rt#publisher",
"rt#redirectdomainaccess",
"rt#rootpublishercluster",
"rt#sdepth",
"rt#ssize",
"rt#sslcipher",
"rt#sslversion",
"rt#tagmaster",
"rt#website"
],
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Available metrics segments",
"tags" : [
"Batch Reporting"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_segments.json?date-from=DD%2FMM%2FYYYY&date-to=DD%2FMM%2FYYYY&kind=rt%23insummary\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_segments.json?date-from=DD/MM/YYYY&date-to=DD/MM/YYYY&kind=rt#insummary',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_segments.json?date-from=DD/MM/YYYY&date-to=DD/MM/YYYY&kind=rt#insummary');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'date-from=DD%2FMM%2FYYYY&date-to=DD%2FMM%2FYYYY&kind=rt%23insummary'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/batch/metrics_segments.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/batch/query.json" : {
"post" : {
"description" : "This query will retrieve data for the provided datasource.\nThe following kind of queries are supported by this endpoint :\n - **RTBatchReportingRequest** for `kind=\"rt#KIND_RT_REPORT\"` : allows you to query all the real-time aggregated data.\n - **EBMDBBatchReportingRequest** for `kind=\"ebmdb#query\"` : allows you to query the Audience Engine and count users linked to a set of queries / clauses.\n - **HQBatchReportingRequest** for `kind=\"hq#query\"` : allows you to query the Human Query Engine and use NLP to access aggregated data.\n - **EDWBatchReportingRequest** for `kind=\"edw#query\"` : allows you to query the Eulerian DataWareHouse Engine\n - **CJAssistAdvancedReportingRequest** for `kind=\"cj#assist-advanced\"` for Customer Journey reports.\n - **CJAssistSimpleReportingRequest** for `kind=\"cj#assist-simple\"` for Customer Journey reports.\n - **CJBiasAdvancedReportingRequest** for `kind=\"cj#bias-advanced\"` for Customer Journey reports.\n - **CJBiasSimpleReportingRequest** for `kind=\"cj#bias-simple\"` for Customer Journey reports.\n - **CJDeviceexclusivityAdvancedReportingRequest** for `kind=\"cj#deviceexclusivity-advanced\"` for Customer Journey reports.\n - **CJDeviceexclusivitySimpleReportingRequest** for `kind=\"cj#deviceexclusivity-simple\"` for Customer Journey reports.\n - **CJDevicepathAdvancedReportingRequest** for `kind=\"cj#devicepath-advanced\"` for Customer Journey reports.\n - **CJDevicepathSimpleReportingRequest** for `kind=\"cj#devicepath-simple\"` for Customer Journey reports.\n - **CJDurationSimpleReportingRequest** for `kind=\"cj#duration-simple\"` for Customer Journey reports.\n - **CJMediaexclusivityAdvancedReportingRequest** for `kind=\"cj#mediaexclusivity-advanced\"` for Customer Journey reports.\n - **CJMediaexclusivitySimpleReportingRequest** for `kind=\"cj#mediaexclusivity-simple\"` for Customer Journey reports.\n - **CJMediapathAdvancedReportingRequest** for `kind=\"cj#mediapath-advanced\"` for Customer Journey reports.\n - **CJMediapathSimpleReportingRequest** for `kind=\"cj#mediapath-simple\"` for Customer Journey reports.\n - **CJQualifyengageSimpleReportingRequest** for `kind=\"cj#qualifyengage-simple\"` for Customer Journey reports.\n - **CJTouchSimpleReportingRequest** for `kind=\"cj#touch-simple\"` for Customer Journey reports.\n - **CJVelocityAdvancedReportingRequest** for `kind=\"cj#velocity-advanced\"` for Customer Journey reports.\n - **CJVelocitySimpleReportingRequest** for `kind=\"cj#velocity-simple\"` for Customer Journey reports.\n\nYou will find **examples** on the right hand side panel that show different ways of requesting data and the expected output you will have.",
"operationId" : "queryBatchReporting",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"01-edw-list-of-pageview-matching-url-with-params" : {
"description" : "Return the list of EulerianId and URL of pages seen on a given period of time that matches a URL that has parameters in it.",
"value" : {
"reports" : [
{
"kind" : "edw#query",
"query" : "GET { TIMERANGE { 1608300022 1608300322 } READERS { ea:pageview@demo-fr AS pageview IF { match( pageview.url, \"http.?://.*?.*\" ) } } OUTPUTS_ROW( pageview ) { pageview.uid,pageview.url } };"
}
]
}
},
"02-ebmdb-raw-query" : {
"description" : "Given the XML query that you can get from the Audience Engine, return the count of users that mathches the query.",
"value" : {
"reports" : [
{
"kind" : "ebmdb#query",
"query" : "\n | Field | Header | Format | Availability |
\n | estimate_id | EA internal ID | Unsigned int | Always |
\n | estimate_ref | Estimate reference | Text | Always |
\n | estimate_date | Estimate date | Epoch UNIX | Always |
\n | estimate_status | Estimate status | PENDING/VALID/INVALID | Always |
\n | estimate_scartvalidamount | Estimate amount | Number | Always |
\n | email_id | Email address | Text | with-email=1 |
\n | estimate_extparam | External parameter | Text | with-extparam=1 |
\n | estimate_ip | IP address | Text | with-ip=1 |
\n | estimate_optin | Optin Status | Text | with-optin=1 |
\n | estimatetype_key | Estimate type | Text | with-estimatetype=1 |
\n | geoloc_name | Country | Coded on 2 ISO-3166-1 characters | with-geoloc=1 |
\n | browser_name | Browser | Text | with-browser=1 |
\n | lang_name | Browser language | Coded on 2 ISO-3166-1 characters | with-lang=1 |
\n | os_name | Operative system | Text | with-os=1 |
\n | isp_name | Internet access provider | Text | with-isp=1 |
\n | action_name | Name of the last validated conversion tracking | Text | with-action=1 |
\n | blockpromo_name | Name of the last clicked auto promotion | Text | with-blockpromo=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel at X level | Text | with-channel-level=X&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel at X level | Text | with-channel-level=X&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel at X level | Text | with-channel-level=X&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 of the channel at X level | Text | with-channel-level=X&max-channel-info=4 |
\n | channel_lvlX_Py | Field P3 to P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=5 |
\n | channel_lvlX_Py | Field P4 to P6 of the channel on level X | Text | with-channel-level=1&max-channel-info=7 |
\n | channel_lvlX_Py | Field P7 to P8 of the channel on level X | Text | with-channel-level=1&max-channel-info=9 |
\n | channel_lvlX_Py | Field P8 to P13 of the channel on level X | Text | with-channel-level=1&max-channel-info=14 |
\n | channel_lvlX_Py | Field P13 to P17 of the channel on level X | Text | with-channel-level=1&max-channel-info=18 |
\n | channel_lvlX_Py | Field P17 to P20 of the channel on level X | Text | with-channel-level=1&max-channel-info=21 |
\n | channel_lvlX_Py | Field P21 to P28 of the channel on level X | Text | with-channel-level=1&max-channel-info=28 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | channel_lvlX_clickid | Click ID from the interaction with the channel on X level | Text | with-channel-level=1&with-channel-clickid=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_Py | Field P21 to P28 of the channel on for provided view-id | Text | max-channel-info=28&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-date=1&view-id=ID_VIEW |
\n | viewchannel_clickid | Click Id from the interaction with the channel for provided view-id | Text | with-channel-clickid=1&view-id=ID_VIEW |
\n | viewchannel_mtascore | Data Driven score for the channel for provided view-id | Text | with-channel-mtascore=1&view-id=ID_VIEW |
\n | a_estimatepage_sz | Number of pages linked to the estimate | All | with-estimatepage=1 |
\n | estimatepage_name_X: X being the page directory | Name of the page | Text | with-estimatepage=1 |
\n | a_estimateproduct_sz | Number of products associated with the estimate | Entirety | with-estimateproduct=1 |
\n | estimateproduct_ref_X: X being the index of the product | Product reference | Text | with-estimateproduct=1 |
\n | estimateproduct_name_X: X being the index of the product | Product name | Text | with-estimateproduct=1 |
\n | estimateproduct_quantity_X: X being the index of the product | Sold product quantity | All | with-estimateproduct=1 |
\n | estimateproduct_sellprice_X: X being the index of the product | Unit amount of the product | Number | with-estimateproduct=1 |
\n | shop_key | Shop key | Text | with-shop=1 |
\n | shop_desc | Shop description | Text | with-shop=1 |
\n
\n\n | Field | Header | Format | Availability |
\n | estimate_id | EA internal ID | Unsigned int | Always |
\n | estimate_ref | Estimate reference | Text | Always |
\n | estimate_date | Estimate date | Epoch UNIX | Always |
\n | estimate_status | Estimate status | PENDING/VALID/INVALID | Always |
\n | estimate_scartvalidamount | Estimate amount | Number | Always |
\n | email_id | Email address | Text | with-email=1 |
\n | estimate_extparam | External parameter | Text | with-extparam=1 |
\n | estimate_ip | IP address | Text | with-ip=1 |
\n | estimate_optin | Optin Status | Text | with-optin=1 |
\n | estimatetype_key | Estimate type | Text | with-estimatetype=1 |
\n | geoloc_name | Country | Coded on 2 ISO-3166-1 characters | with-geoloc=1 |
\n | browser_name | Browser | Text | with-browser=1 |
\n | lang_name | Browser language | Coded on 2 ISO-3166-1 characters | with-lang=1 |
\n | os_name | Operative system | Text | with-os=1 |
\n | isp_name | Internet access provider | Text | with-isp=1 |
\n | action_name | Name of the last validated conversion tracking | Text | with-action=1 |
\n | blockpromo_name | Name of the last clicked auto promotion | Text | with-blockpromo=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel at X level | Text | with-channel-level=X&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel at X level | Text | with-channel-level=X&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel at X level | Text | with-channel-level=X&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 of the channel at X level | Text | with-channel-level=X&max-channel-info=4 |
\n | channel_lvlX_Py | Field P3 to P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=5 |
\n | channel_lvlX_Py | Field P4 to P6 of the channel on level X | Text | with-channel-level=1&max-channel-info=7 |
\n | channel_lvlX_Py | Field P7 to P8 of the channel on level X | Text | with-channel-level=1&max-channel-info=9 |
\n | channel_lvlX_Py | Field P8 to P13 of the channel on level X | Text | with-channel-level=1&max-channel-info=14 |
\n | channel_lvlX_Py | Field P13 to P17 of the channel on level X | Text | with-channel-level=1&max-channel-info=18 |
\n | channel_lvlX_Py | Field P17 to P20 of the channel on level X | Text | with-channel-level=1&max-channel-info=21 |
\n | channel_lvlX_Py | Field P21 to P28 of the channel on level X | Text | with-channel-level=1&max-channel-info=28 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | channel_lvlX_clickid | Click ID from the interaction with the channel on X level | Text | with-channel-level=1&with-channel-clickid=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_Py | Field P21 to P28 of the channel on for provided view-id | Text | max-channel-info=28&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-date=1&view-id=ID_VIEW |
\n | viewchannel_clickid | Click Id from the interaction with the channel for provided view-id | Text | with-channel-clickid=1&view-id=ID_VIEW |
\n | viewchannel_mtascore | Data Driven score for the channel for provided view-id | Text | with-channel-mtascore=1&view-id=ID_VIEW |
\n | a_estimatepage_sz | Number of pages linked to the estimate | All | with-estimatepage=1 |
\n | estimatepage_name_X: X being the page directory | Name of the page | Text | with-estimatepage=1 |
\n | a_estimateproduct_sz | Number of products associated with the estimate | Entirety | with-estimateproduct=1 |
\n | estimateproduct_ref_X: X being the index of the product | Product reference | Text | with-estimateproduct=1 |
\n | estimateproduct_name_X: X being the index of the product | Product name | Text | with-estimateproduct=1 |
\n | estimateproduct_quantity_X: X being the index of the product | Sold product quantity | All | with-estimateproduct=1 |
\n | estimateproduct_sellprice_X: X being the index of the product | Unit amount of the product | Number | with-estimateproduct=1 |
\n | shop_key | Shop key | Text | with-shop=1 |
\n | shop_desc | Shop description | Text | with-shop=1 |
\n
\n\n | Field | Header | Format | Availability |
\n | order_id | EA internal ID | Unsigned int | Always |
\n | order_ref | Sale reference | Text | Always |
\n | order_date | Sale date | Epoch UNIX | Always |
\n | order_status | Status of the sale | PENDING/VALID/INVALID | Always |
\n | order_scartvalidamount | Sale amount | Number | Always |
\n | email_id | Email address | Text | with-email=1 |
\n | order_extparam | External parameter | Text | with-extparam=1 |
\n | order_ip | IP address | Text | with-ip=1 |
\n | order_optin | Optin Status | Text | with-optin=1 |
\n | ordertype_key | Type of sale | Text | with-ordertype=1 |
\n | orderpayment_key | Type of payment | Text | with-orderpayment=1 |
\n | geoloc_name | Country | Coded on 2 ISO-3166-1 characters | with-geoloc=1 |
\n | browser_name | Browser | Text | with-browser=1 |
\n | lang_name | Browser language | Coded on 2 ISO-3166-1 characters | with-lang=1 |
\n | os_name | Operating system | Text | with-os=1 |
\n | isp_name | Internet access provider | Text | with-isp=1 |
\n | action_name | Name of the last validated conversion tracking | Text | with-action=1 |
\n | blockpromo_name | Name of the last clicked auto promotion | Text | with-blockpromo=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel on level X | Text | with-channel-level=1&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel on level X | Text | with-channel-level=1&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 to P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=5 |
\n | channel_lvlX_Py | Field P4 to P6 of the channel on level X | Text | with-channel-level=1&max-channel-info=7 |
\n | channel_lvlX_Py | Field P7 to P8 of the channel on level X | Text | with-channel-level=1&max-channel-info=9 |
\n | channel_lvlX_Py | Field P8 to P13 of the channel on level X | Text | with-channel-level=1&max-channel-info=14 |
\n | channel_lvlX_Py | Field P13 to P17 of the channel on level X | Text | with-channel-level=1&max-channel-info=18 |
\n | channel_lvlX_Py | Field P17 to P20 of the channel on level X | Text | with-channel-level=1&max-channel-info=21 |
\n | channel_lvlX_Py | Field P21 to P28 of the channel on level X | Text | with-channel-level=1&max-channel-info=28 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | channel_lvlX_clickid | Click ID at X level for the channel | Text | with-channel-level=1&with-channel-clickid=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_Py | Field P21 to P28 of the channel on for provided view-id | Text | max-channel-info=28&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-date=1&view-id=ID_VIEW |
\n | viewchannel_clickid | Click ID for the channel for provided view-id | Text | with-channel-clickid=1&view-id=ID_VIEW |
\n | viewchannel_mtascore | Data Driven score for the channel for provided view-id | Text | with-channel-mtascore=1&view-id=ID_VIEW |
\n | a_orderpage_sz | Number of pages associated with the sale | Total | with-orderpage=1 |
\n | orderpage_name_X: X being the page index | Name of the page | Text | with-orderpage=1 |
\n | a_orderproduct_sz | Number of products associated with the sale | Total | with-orderproduct=1 |
\n | orderproduct_ref_X : X being the index of the product | Product reference | Text | with-orderproduct=1 |
\n | orderproduct_name_X : X being the index of the product | Product name | Text | with-orderproduct=1 |
\n | orderproduct_quantity_X: X being the index of the product | Quantity of product sold | Total | with-orderproduct=1 |
\n | orderproduct_sellprice_X : X being the index of the product | Unitary sell price | Number | with-orderproduct=1 |
\n | shop_key | Shop key | Text | with-shop=1 |
\n | shop_desc | Shop description | Text | with-shop=1 |
\n
\n\n | Field | Header | Format | Availability |
\n | order_id | EA internal ID | Unsigned int | Always |
\n | order_ref | Sale reference | Text | Always |
\n | order_date | Sale date | Epoch UNIX | Always |
\n | order_status | Status of the sale | PENDING/VALID/INVALID | Always |
\n | order_scartvalidamount | Sale amount | Number | Always |
\n | email_id | Email address | Text | with-email=1 |
\n | order_extparam | External parameter | Text | with-extparam=1 |
\n | order_ip | IP address | Text | with-ip=1 |
\n | order_optin | Optin Status | Text | with-optin=1 |
\n | ordertype_key | Type of sale | Text | with-ordertype=1 |
\n | orderpayment_key | Type of payment | Text | with-orderpayment=1 |
\n | geoloc_name | Country | Coded on 2 ISO-3166-1 characters | with-geoloc=1 |
\n | browser_name | Browser | Text | with-browser=1 |
\n | lang_name | Browser language | Coded on 2 ISO-3166-1 characters | with-lang=1 |
\n | os_name | Operating system | Text | with-os=1 |
\n | isp_name | Internet access provider | Text | with-isp=1 |
\n | action_name | Name of the last validated conversion tracking | Text | with-action=1 |
\n | blockpromo_name | Name of the last clicked auto promotion | Text | with-blockpromo=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel on level X | Text | with-channel-level=1&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel on level X | Text | with-channel-level=1&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 to P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=5 |
\n | channel_lvlX_Py | Field P4 to P6 of the channel on level X | Text | with-channel-level=1&max-channel-info=7 |
\n | channel_lvlX_Py | Field P7 to P8 of the channel on level X | Text | with-channel-level=1&max-channel-info=9 |
\n | channel_lvlX_Py | Field P8 to P13 of the channel on level X | Text | with-channel-level=1&max-channel-info=14 |
\n | channel_lvlX_Py | Field P13 to P17 of the channel on level X | Text | with-channel-level=1&max-channel-info=18 |
\n | channel_lvlX_Py | Field P17 to P20 of the channel on level X | Text | with-channel-level=1&max-channel-info=21 |
\n | channel_lvlX_Py | Field P21 to P28 of the channel on level X | Text | with-channel-level=1&max-channel-info=28 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | channel_lvlX_clickid | Click ID at X level for the channel | Text | with-channel-level=1&with-channel-clickid=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_Py | Field P21 to P28 of the channel on for provided view-id | Text | max-channel-info=28&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-date=1&view-id=ID_VIEW |
\n | viewchannel_clickid | Click ID for the channel for provided view-id | Text | with-channel-clickid=1&view-id=ID_VIEW |
\n | viewchannel_mtascore | Data Driven score for the channel for provided view-id | Text | with-channel-mtascore=1&view-id=ID_VIEW |
\n | a_orderpage_sz | Number of pages associated with the sale | Total | with-orderpage=1 |
\n | orderpage_name_X: X being the page index | Name of the page | Text | with-orderpage=1 |
\n | a_orderproduct_sz | Number of products associated with the sale | Total | with-orderproduct=1 |
\n | orderproduct_ref_X : X being the index of the product | Product reference | Text | with-orderproduct=1 |
\n | orderproduct_name_X : X being the index of the product | Product name | Text | with-orderproduct=1 |
\n | orderproduct_quantity_X: X being the index of the product | Quantity of product sold | Total | with-orderproduct=1 |
\n | orderproduct_sellprice_X : X being the index of the product | Unitary sell price | Number | with-orderproduct=1 |
\n | shop_key | Shop key | Text | with-shop=1 |
\n | shop_desc | Shop description | Text | with-shop=1 |
\n
\n\n | Field | Header | Format | Availability |
\n | scart_id | EA internal ID | Unsigned int | Always |
\n | scart_date | Sale date | Epoch UNIX | Always |
\n | order_ref | Sale ID | Text | with-orderid=1 |
\n | email_id | Email address | Text | with-email=1 |
\n | scart_extparam | External parameter | Text | with-extparam=1 |
\n | scart_optin | Optin Status | Text | with-optin=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel at X level | Text | with-channel-level=X&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel at X level | Text | with-channel-level=X&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel at X level | Text | with-channel-level=X&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 of the channel at X level | Text | with-channel-level=X&max-channel-info=4 |
\n | channel_lvlX_Py | Field P3 to P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=5 |
\n | channel_lvlX_Py | Field P4 to P6 of the channel on level X | Text | with-channel-level=1&max-channel-info=7 |
\n | channel_lvlX_Py | Field P7 to P8 of the channel on level X | Text | with-channel-level=1&max-channel-info=9 |
\n | channel_lvlX_Py | Field P8 to P13 of the channel on level X | Text | with-channel-level=1&max-channel-info=14 |
\n | channel_lvlX_Py | Field P13 to P17 of the channel on level X | Text | with-channel-level=1&max-channel-info=18 |
\n | channel_lvlX_Py | Field P17 to P20 of the channel on level X | Text | with-channel-level=1&max-channel-info=21 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_mtascore | Data Driven score for the channel for provided view-id | Text | with-channel-mtascore=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | &with-channel-date=1&view-id=ID_VIEW |
\n | a_scartproduct_sz | Number of products linked to the sale | Total | with-scartproduct=1 |
\n | scartproduct_ref_X : X being the product index | Product reference | Text | with-scartproduct=1 |
\n | scartproduct_name_X : X being the product index | Product reference | Text | with-scartproduct=1 |
\n | scartproduct_quantity_X : X being the product index | Quantity of the product sold | Total | with-scartproduct=1 |
\n | scartproduct_sellprice_X : X being the product index | Product unitary amount | Number | with-scartproduct=1 |
\n
\n",
"operationId" : "downloadDatamining:shoppingcarts",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as a CSV file.",
"example" : 1,
"in" : "query",
"name" : "output-as-csv",
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as an array of key/value fields.",
"example" : 1,
"in" : "query",
"name" : "output-as-kv",
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "scart_id"
}
],
"rows" : [
[
"SCART-1777564990"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Download the report",
"tags" : [
"Datamining: shopping carts"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990&output-as-csv=1&output-as-kv=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/download.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/scart/get.json" : {
"get" : {
"description" : "This query will return a specific shopping cart.\n\nThe following fields are returned depending on the request parameters :\n\n | Field | Header | Format | Availability |
\n | scart_id | EA internal ID | Unsigned int | Always |
\n | scart_date | Sale date | Epoch UNIX | Always |
\n | order_ref | Sale ID | Text | with-orderid=1 |
\n | email_id | Email address | Text | with-email=1 |
\n | scart_extparam | External parameter | Text | with-extparam=1 |
\n | scart_optin | Optin Status | Text | with-optin=1 |
\n | cgiparam_$ID : $ID being the custom parameter internal ID | Custom parameter | Text | with-cgiparam=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel at X level | Text | with-channel-level=X&max-channel-info=1 |
\n | channel_lvlX_P1 | Field P1 of the channel at X level | Text | with-channel-level=X&max-channel-info=2 |
\n | channel_lvlX_P2 | Field P2 of the channel at X level | Text | with-channel-level=X&max-channel-info=3 |
\n | channel_lvlX_P3 | Field P3 of the channel at X level | Text | with-channel-level=X&max-channel-info=4 |
\n | channel_lvlX_Py | Field P3 to P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=5 |
\n | channel_lvlX_Py | Field P4 to P6 of the channel on level X | Text | with-channel-level=1&max-channel-info=7 |
\n | channel_lvlX_Py | Field P7 to P8 of the channel on level X | Text | with-channel-level=1&max-channel-info=9 |
\n | channel_lvlX_Py | Field P8 to P13 of the channel on level X | Text | with-channel-level=1&max-channel-info=14 |
\n | channel_lvlX_Py | Field P13 to P17 of the channel on level X | Text | with-channel-level=1&max-channel-info=18 |
\n | channel_lvlX_Py | Field P17 to P20 of the channel on level X | Text | with-channel-level=1&max-channel-info=21 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n | viewchannel_P0 | Field P0 of the channel for provided view-id | Text | max-channel-info=1&view-id=ID_VIEW |
\n | viewchannel_P1 | Field P1 of the channel for provided view-id | Text | max-channel-info=2&view-id=ID_VIEW |
\n | viewchannel_P2 | Field P2 of the channel for provided view-id | Text | max-channel-info=3&view-id=ID_VIEW |
\n | viewchannel_P3 | Field P3 to P4 of the channel for provided view-id | Text | max-channel-info=5&view-id=ID_VIEW |
\n | viewchannel_Py | Field P4 to P6 of the channel for provided view-id | Text | max-channel-info=7&view-id=ID_VIEW |
\n | viewchannel_Py | Field P7 to P8 of the channel for provided view-id | Text | max-channel-info=9&view-id=ID_VIEW |
\n | viewchannel_Py | Field P8 to P13 of the channel for provided view-id | Text | max-channel-info=14&view-id=ID_VIEW |
\n | viewchannel_Py | Field P13 to P17 of the channel for provided view-id | Text | max-channel-info=18&view-id=ID_VIEW |
\n | viewchannel_Py | Field P17 to P20 of the channel on for provided view-id | Text | max-channel-info=21&view-id=ID_VIEW |
\n | viewchannel_via | Type of interaction for the channel for provided view-id: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-via=1&view-id=ID_VIEW |
\n | viewchannel_mtascore | Data Driven score for the channel for provided view-id | Text | with-channel-mtascore=1&view-id=ID_VIEW |
\n | viewchannel_date | Date from the interaction with the channel on X level | Epoch UNIX | &with-channel-date=1&view-id=ID_VIEW |
\n | a_scartproduct_sz | Number of products linked to the sale | Total | with-scartproduct=1 |
\n | scartproduct_ref_X : X being the product index | Product reference | Text | with-scartproduct=1 |
\n | scartproduct_name_X : X being the product index | Product reference | Text | with-scartproduct=1 |
\n | scartproduct_quantity_X : X being the product index | Quantity of the product sold | Total | with-scartproduct=1 |
\n | scartproduct_sellprice_X : X being the product index | Product unitary amount | Number | with-scartproduct=1 |
\n
\n",
"operationId" : "getDatamining:shoppingcarts",
"parameters" : [
{
"description" : "shopping cart id",
"example" : "scart-1777564990",
"in" : "query",
"name" : "scart-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Eulerian identifier (EUID)",
"example" : 1,
"in" : "query",
"name" : "with-buyerid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CGI params",
"example" : 1,
"in" : "query",
"name" : "with-cgiparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: total number of interactions",
"example" : 1,
"in" : "query",
"name" : "with-channel-count",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: interaction date per channel",
"example" : 1,
"in" : "query",
"name" : "with-channel-date",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: level of detail of the marketing channels",
"example" : 1,
"in" : "query",
"name" : "with-channel-level",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Interaction type (post-clic/post-impression/revisit)",
"example" : 1,
"in" : "query",
"name" : "with-channel-via",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: audience",
"example" : 1,
"in" : "query",
"name" : "with-cluster",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: email",
"example" : 1,
"in" : "query",
"name" : "with-email",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: estimate reference",
"example" : 1,
"in" : "query",
"name" : "with-estimateid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: external parameter",
"example" : 1,
"in" : "query",
"name" : "with-extparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: first channel",
"example" : 1,
"in" : "query",
"name" : "with-first-channel",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: user-centric parameters",
"example" : 1,
"in" : "query",
"name" : "with-iduserparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: last channel",
"example" : 1,
"in" : "query",
"name" : "with-last-channel",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: OptIn status",
"example" : 1,
"in" : "query",
"name" : "with-optin",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: sales unique id",
"example" : 1,
"in" : "query",
"name" : "with-orderid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: product parameters",
"example" : 1,
"in" : "query",
"name" : "with-productparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: list of products in shopping cart",
"example" : 1,
"in" : "query",
"name" : "with-scartproduct",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: attribution rule",
"example" : 1,
"in" : "query",
"name" : "with-scartview",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CRM identifier (UID)",
"example" : 1,
"in" : "query",
"name" : "with-userid",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a shopping cart.",
"tags" : [
"Datamining: shopping carts"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/get.json?scart-id=scart-1777564990&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/get.json?scart-id=scart-1777564990&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/get.json?scart-id=scart-1777564990&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'scart-id=scart-1777564990&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/get.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/scart/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.\n\nPlease check the following [section](#section/Introduction/Asynchronous-calls) for more information about the download process.",
"operationId" : "searchDatamining:shoppingcarts",
"parameters" : [
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/15/2018",
"in" : "query",
"name" : "date-from",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/29/2018",
"in" : "query",
"name" : "date-to",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "set this flag to 1 if you want the dates to be formatted according to a preset format, otherwise you will always have epoch format times.",
"example" : 1,
"in" : "query",
"name" : "ea-enable-datefmt",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Column: Eulerian identifier (EUID)",
"example" : 1,
"in" : "query",
"name" : "with-buyerid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CGI params",
"example" : 1,
"in" : "query",
"name" : "with-cgiparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: total number of interactions",
"example" : 1,
"in" : "query",
"name" : "with-channel-count",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: interaction date per channel",
"example" : 1,
"in" : "query",
"name" : "with-channel-date",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: level of detail of the marketing channels",
"example" : 1,
"in" : "query",
"name" : "with-channel-level",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Interaction type (post-clic/post-impression/revisit)",
"example" : 1,
"in" : "query",
"name" : "with-channel-via",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: audience",
"example" : 1,
"in" : "query",
"name" : "with-cluster",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: email",
"example" : 1,
"in" : "query",
"name" : "with-email",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: estimate reference",
"example" : 1,
"in" : "query",
"name" : "with-estimateid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: external parameter",
"example" : 1,
"in" : "query",
"name" : "with-extparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: first channel",
"example" : 1,
"in" : "query",
"name" : "with-first-channel",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: user-centric parameters",
"example" : 1,
"in" : "query",
"name" : "with-iduserparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: last channel",
"example" : 1,
"in" : "query",
"name" : "with-last-channel",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: OptIn status",
"example" : 1,
"in" : "query",
"name" : "with-optin",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: sales unique id",
"example" : 1,
"in" : "query",
"name" : "with-orderid",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: product parameters",
"example" : 1,
"in" : "query",
"name" : "with-productparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: list of products in shopping cart",
"example" : 1,
"in" : "query",
"name" : "with-scartproduct",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: attribution rule",
"example" : 1,
"in" : "query",
"name" : "with-scartview",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CRM identifier (UID)",
"example" : 1,
"in" : "query",
"name" : "with-userid",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Datamining: shopping carts"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/search.json?date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-buyerid=1&with-cgiparam=1&with-channel-count=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-cluster=1&with-email=1&with-estimateid=1&with-extparam=1&with-first-channel=1&with-iduserparam=1&with-last-channel=1&with-optin=1&with-orderid=1&with-productparam=1&with-scartproduct=1&with-scartview=1&with-userid=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/scart/status.json" : {
"get" : {
"description" : "When sending a `search` request, you can check the generation status of the report by querying this method.",
"operationId" : "statusDatamining:shoppingcarts",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_status"
}
],
"rows" : [
[
"INPROGRESS"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the generation status.",
"tags" : [
"Datamining: shopping carts"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/status.json?jobrun-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/status.json?jobrun-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/status.json?jobrun-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/scart/status.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tpopedataclick/download.json" : {
"get" : {
"description" : "Once the report is available (COMPLETED) you can download the data by querying this method.\n\nThe following fields are returned depending on the request parameters :\n\n | Field | Header | Format | Availability |
\n | tpopedataclick_id | EA internal ID | Unsigned int | Always |
\n | tpopedataclick_date | Outbound click date | Epoch UNIX | Always |
\n | tpopedataclick_extparam | External parameter | Text | with-extparam=1 |
\n | tpopedataclick_scoring | Outbound click scoring | Unsigned int | Always |
\n | tpopedataclick_scoringdesc | Outbound click scoring description | Text | with-scoringdesc=1 |
\n | tppublisher_name | Name of the publisher | Text | with-tppublisher-name=1 |
\n | tpope_name | Name of the outbound campaign | Text | with-tpope-name=1 |
\n | tpopedata_name | Name of the campaign outbound click | Text | with-tpopedata-name=1 |
\n | channel_lvl0_P0 | Field P0 of the channel, level X | Text | with-channel-level=1 |
\n | channel_lvl0_P1 | Field P1 of the channel, level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvl0_P2 | Field P2 of the channel, level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvl0_P3 | Field P3 of the channel, level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvl0_P4 | Field P4 of the channel, level X | Text | with-channel-level=1&max-channel-info=1 |
\n
\n",
"operationId" : "downloadDatamining:outboundclicks",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as a CSV file.",
"example" : 1,
"in" : "query",
"name" : "output-as-csv",
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as an array of key/value fields.",
"example" : 1,
"in" : "query",
"name" : "output-as-kv",
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "tpopedataclick_id"
}
],
"rows" : [
[
"ID-TPOPEDATACLICK-1777564990"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Download the report",
"tags" : [
"Datamining: outbound clicks"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990&output-as-csv=1&output-as-kv=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/download.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tpopedataclick/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.\n\nPlease check the following [section](#section/Introduction/Asynchronous-calls) for more information about the download process.",
"operationId" : "searchDatamining:outboundclicks",
"parameters" : [
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/15/2018",
"in" : "query",
"name" : "date-from",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/29/2018",
"in" : "query",
"name" : "date-to",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "set this flag to 1 if you want the dates to be formatted according to a preset format, otherwise you will always have epoch format times.",
"example" : 1,
"in" : "query",
"name" : "ea-enable-datefmt",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Datamining: outbound clicks"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/search.json?date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tpopedataclick/status.json" : {
"get" : {
"description" : "When sending a `search` request, you can check the generation status of the report by querying this method.",
"operationId" : "statusDatamining:outboundclicks",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_status"
}
],
"rows" : [
[
"INPROGRESS"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the generation status.",
"tags" : [
"Datamining: outbound clicks"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/status.json?jobrun-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/status.json?jobrun-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/status.json?jobrun-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tpopedataclick/status.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tporder/download.json" : {
"get" : {
"description" : "Once the report is available (COMPLETED) you can download the data by querying this method.\n\nThe following fields are returned depending on the request parameters :\n\n | Field | Header | Format | Availability |
\n | tporder_id | EA internal ID | Unsigned int | Always |
\n | tporder_ref | Third-party sale reference | Text | Always |
\n | tporder_date | Third-party sale date | Epoch UNIX | Always |
\n | tporder_status | Status of the third-party sale | PENDING/VALID/INVALID | Always |
\n | tporder_scartvalidamount | Third-party sale amount | Number | Always |
\n | email_id | Email address | Text | with-email=1 |
\n | tporder_extparam | External parameter | Text | with-extparam=1 |
\n | tporder_ip | IP address | Text | with-ip=1 |
\n | geoloc_name | Country | Coded on 2 ISO-3166-1 characters | with-geoloc=1 |
\n | browser_name | Browser | Text | with-browser=1 |
\n | lang_name | Browser language | Coded on 2 ISO-3166-1 characters | with-lang=1 |
\n | os_name | Operative system | Text | with-os=1 |
\n | isp_name | Internet access provider | Text | with-isp=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel on level X | Text | with-channel-level=1 |
\n | channel_lvlX_P1 | Field P1 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P2 | Field P2 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P3 | Field P3 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P4 | Field P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n
\n",
"operationId" : "downloadDatamining:thirdpartysales",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as a CSV file.",
"example" : 1,
"in" : "query",
"name" : "output-as-csv",
"schema" : {
"type" : "string"
}
},
{
"description" : "If set to 1, the output will be formatted as an array of key/value fields.",
"example" : 1,
"in" : "query",
"name" : "output-as-kv",
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "tporder_ref"
}
],
"rows" : [
[
"REF-TPORDER-1777564990"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Download the report",
"tags" : [
"Datamining: third-party sales"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/download.json?jobrun-id=1777564990&output-as-csv=1&output-as-kv=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990&output-as-csv=1&output-as-kv=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/download.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tporder/get.json" : {
"get" : {
"description" : "This query will return a specific third-party sale.\n\nThe following fields are returned depending on the request parameters :\n\n | Field | Header | Format | Availability |
\n | tporder_id | EA internal ID | Unsigned int | Always |
\n | tporder_ref | Third-party sale reference | Text | Always |
\n | tporder_date | Third-party sale date | Epoch UNIX | Always |
\n | tporder_status | Status of the third-party sale | PENDING/VALID/INVALID | Always |
\n | tporder_scartvalidamount | Third-party sale amount | Number | Always |
\n | email_id | Email address | Text | with-email=1 |
\n | tporder_extparam | External parameter | Text | with-extparam=1 |
\n | tporder_ip | IP address | Text | with-ip=1 |
\n | geoloc_name | Country | Coded on 2 ISO-3166-1 characters | with-geoloc=1 |
\n | browser_name | Browser | Text | with-browser=1 |
\n | lang_name | Browser language | Coded on 2 ISO-3166-1 characters | with-lang=1 |
\n | os_name | Operative system | Text | with-os=1 |
\n | isp_name | Internet access provider | Text | with-isp=1 |
\n | a_channel_sz | Total number of channels in the marketing history | Total | with-channel-count=1&with-channel-level=1 |
\n | channel_lvlX_P0 | Field P0 of the channel on level X | Text | with-channel-level=1 |
\n | channel_lvlX_P1 | Field P1 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P2 | Field P2 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P3 | Field P3 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_P4 | Field P4 of the channel on level X | Text | with-channel-level=1&max-channel-info=1 |
\n | channel_lvlX_via | Type of interaction at X level for the channel: C: post-click/V: post-impression/R: out of session/Empty: none | Text | with-channel-level=1&with-channel-via=1 |
\n | channel_lvlX_date | Date from the interaction with the channel on X level | Epoch UNIX | with-channel-level=1&with-channel-date=1 |
\n
\n",
"operationId" : "getDatamining:thirdpartysales",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "tporder reference",
"example" : "ref-tporder-1777564990",
"in" : "query",
"name" : "tporder-ref",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: conversion tracking",
"example" : 1,
"in" : "query",
"name" : "with-action",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: browser",
"example" : 1,
"in" : "query",
"name" : "with-browser",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CGI params",
"example" : 1,
"in" : "query",
"name" : "with-cgiparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: interaction date per channel",
"example" : 1,
"in" : "query",
"name" : "with-channel-date",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: level of detail of the marketing channels",
"example" : 1,
"in" : "query",
"name" : "with-channel-level",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Interaction type (post-clic/post-impression/revisit)",
"example" : 1,
"in" : "query",
"name" : "with-channel-via",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: conversion date (DD/MM/YYYY)",
"example" : 1,
"in" : "query",
"name" : "with-date-dmy",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: conversion date (EPOCH)",
"example" : 1,
"in" : "query",
"name" : "with-date-epoch",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: date (HH:MM:SS)",
"example" : 1,
"in" : "query",
"name" : "with-date-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: outbound click date (EPOCH)",
"example" : 1,
"in" : "query",
"name" : "with-dateout",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: outbound click date (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-dateout-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: date of the visit",
"example" : 1,
"in" : "query",
"name" : "with-datevisit",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: date of the visit (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-datevisit-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: email",
"example" : 1,
"in" : "query",
"name" : "with-email",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: external parameter",
"example" : 1,
"in" : "query",
"name" : "with-extparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: country",
"example" : 1,
"in" : "query",
"name" : "with-geoloc",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: IP address",
"example" : 1,
"in" : "query",
"name" : "with-ip",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: ISP",
"example" : 1,
"in" : "query",
"name" : "with-isp",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: language",
"example" : 1,
"in" : "query",
"name" : "with-lang",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: operating system",
"example" : 1,
"in" : "query",
"name" : "with-os",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: delay since the outbound click (seconds)",
"example" : 1,
"in" : "query",
"name" : "with-outlag",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: delay since the outbound click (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-outlag-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: product SKU",
"example" : 1,
"in" : "query",
"name" : "with-product",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: category",
"example" : 1,
"in" : "query",
"name" : "with-tpcategory",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: media",
"example" : 1,
"in" : "query",
"name" : "with-tpmedia",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: outbound campaign",
"example" : 1,
"in" : "query",
"name" : "with-tpope",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: name of the outbound click",
"example" : 1,
"in" : "query",
"name" : "with-tpopedataname",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: publisher",
"example" : 1,
"in" : "query",
"name" : "with-tppublisher",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: length of the visit",
"example" : 1,
"in" : "query",
"name" : "with-visitlag",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: length of the visit (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-visitlag-hms",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a third-party sale.",
"tags" : [
"Datamining: third-party sales"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/get.json?tporder-ref=ref-tporder-1777564990&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/get.json?tporder-ref=ref-tporder-1777564990&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/get.json?tporder-ref=ref-tporder-1777564990&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'tporder-ref=ref-tporder-1777564990&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/get.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tporder/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.\n\nPlease check the following [section](#section/Introduction/Asynchronous-calls) for more information about the download process.",
"operationId" : "searchDatamining:thirdpartysales",
"parameters" : [
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/15/2018",
"in" : "query",
"name" : "date-from",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "date from which the data is requested, format: MM/DD/YYYY",
"example" : "01/29/2018",
"in" : "query",
"name" : "date-to",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "set this flag to 1 if you want the dates to be formatted according to a preset format, otherwise you will always have epoch format times.",
"example" : 1,
"in" : "query",
"name" : "ea-enable-datefmt",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Column: conversion tracking",
"example" : 1,
"in" : "query",
"name" : "with-action",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: browser",
"example" : 1,
"in" : "query",
"name" : "with-browser",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: CGI params",
"example" : 1,
"in" : "query",
"name" : "with-cgiparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: interaction date per channel",
"example" : 1,
"in" : "query",
"name" : "with-channel-date",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: level of detail of the marketing channels",
"example" : 1,
"in" : "query",
"name" : "with-channel-level",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: Interaction type (post-clic/post-impression/revisit)",
"example" : 1,
"in" : "query",
"name" : "with-channel-via",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: conversion date (DD/MM/YYYY)",
"example" : 1,
"in" : "query",
"name" : "with-date-dmy",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: conversion date (EPOCH)",
"example" : 1,
"in" : "query",
"name" : "with-date-epoch",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: date (HH:MM:SS)",
"example" : 1,
"in" : "query",
"name" : "with-date-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: outbound click date (EPOCH)",
"example" : 1,
"in" : "query",
"name" : "with-dateout",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: outbound click date (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-dateout-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: date of the visit",
"example" : 1,
"in" : "query",
"name" : "with-datevisit",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: date of the visit (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-datevisit-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: email",
"example" : 1,
"in" : "query",
"name" : "with-email",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: external parameter",
"example" : 1,
"in" : "query",
"name" : "with-extparam",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: country",
"example" : 1,
"in" : "query",
"name" : "with-geoloc",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: IP address",
"example" : 1,
"in" : "query",
"name" : "with-ip",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: ISP",
"example" : 1,
"in" : "query",
"name" : "with-isp",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: language",
"example" : 1,
"in" : "query",
"name" : "with-lang",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: operating system",
"example" : 1,
"in" : "query",
"name" : "with-os",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: delay since the outbound click (seconds)",
"example" : 1,
"in" : "query",
"name" : "with-outlag",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: delay since the outbound click (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-outlag-hms",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: product SKU",
"example" : 1,
"in" : "query",
"name" : "with-product",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: category",
"example" : 1,
"in" : "query",
"name" : "with-tpcategory",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: media",
"example" : 1,
"in" : "query",
"name" : "with-tpmedia",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: outbound campaign",
"example" : 1,
"in" : "query",
"name" : "with-tpope",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: name of the outbound click",
"example" : 1,
"in" : "query",
"name" : "with-tpopedataname",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: publisher",
"example" : 1,
"in" : "query",
"name" : "with-tppublisher",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: length of the visit",
"example" : 1,
"in" : "query",
"name" : "with-visitlag",
"schema" : {
"type" : "string"
}
},
{
"description" : "Column: length of the visit (hh:mm:ss)",
"example" : 1,
"in" : "query",
"name" : "with-visitlag-hms",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Datamining: third-party sales"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/search.json?date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/search.json?date-from=01/15/2018&date-to=01/29/2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'date-from=01%2F15%2F2018&date-to=01%2F29%2F2018&dir=DESC&ea-enable-datefmt=1&limit=25&start=0&with-action=1&with-browser=1&with-cgiparam=1&with-channel-date=1&with-channel-level=1&with-channel-via=1&with-date-dmy=1&with-date-epoch=1&with-date-hms=1&with-dateout=1&with-dateout-hms=1&with-datevisit=1&with-datevisit-hms=1&with-email=1&with-extparam=1&with-geoloc=1&with-ip=1&with-isp=1&with-lang=1&with-os=1&with-outlag=1&with-outlag-hms=1&with-product=1&with-tpcategory=1&with-tpmedia=1&with-tpope=1&with-tpopedataname=1&with-tppublisher=1&with-visitlag=1&with-visitlag-hms=1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/report/tporder/status.json" : {
"get" : {
"description" : "When sending a `search` request, you can check the generation status of the report by querying this method.",
"operationId" : "statusDatamining:thirdpartysales",
"parameters" : [
{
"description" : "id of the jobrun generating the report as provided by the `search` query",
"example" : 1777564990,
"in" : "query",
"name" : "jobrun-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "jobrun_status"
}
],
"rows" : [
[
"INPROGRESS"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the generation status.",
"tags" : [
"Datamining: third-party sales"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/status.json?jobrun-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/status.json?jobrun-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/status.json?jobrun-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'jobrun-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/report/tporder/status.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/edw/jobs" : {
"post" : {
"description" : "Add and start a new Eulerian Data Warehouse Analysis on remote servers.",
"operationId" : "jobsEDWJobs",
"parameters" : [
{
"description" : "JSON message used to create an Eulerian Data Warehouse Analysis.",
"in" : "query",
"name" : "message",
"required" : true,
"schema" : {
"$ref" : "#/definitions/edwRequestItem"
}
}
],
"responses" : {
"200" : {
"description" : "Eulerian Data Warehouse Analysis was successfully created and started on remote servers.",
"schema" : {
"$ref" : "#/definitions/edwResponseItem"
}
}
},
"summary" : "Add and start a new Eulerian Data Warehouse Analysis.",
"tags" : [
"EDW-Jobs"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST https://{customer}.edw.eulerian.{datacenter}/edw/jobs"
},
{
"lang" : "php",
"source" : " 'https://{customer}.edw.eulerian.{datacenter}/edw/jobs',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.edw.eulerian.{datacenter}/edw/jobs');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n \n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/edw/jobs/{jobid}" : {
"get" : {
"description" : "Get the status of an existing Eulerian Data Warehouse Analysis on remote servers.",
"operationId" : "jobs/{jobid}EDWJobs",
"parameters" : [
{
"description" : "Eulerian Data Warehouse Analysis identifier.",
"in" : "path",
"name" : "jobid",
"required" : true,
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"description" : "Successfully retrieved the status of an Eulerian Data Warehouse Analysis on remote servers",
"schema" : {
"$ref" : "#/definitions/edwResponseItem"
}
}
},
"summary" : "Get the status of an existing Eulerian Data Warehouse Analysis.",
"tags" : [
"EDW-Jobs"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}', params=payload)\nprint(response.json())\n"
}
]
}
},
"/edw/jobs/{jobid}/cancel" : {
"get" : {
"description" : "Cancel an existing Eulerian Data Warehouse Analysis on remote servers.",
"operationId" : "jobs/{jobid}/cancelEDWJobs",
"parameters" : [
{
"description" : "Eulerian Data Warehouse Analysis identifier.",
"in" : "path",
"name" : "jobid",
"required" : true,
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"description" : "Successfully cancelled the Eulerian Data Warehouse Analysis on remote servers.",
"schema" : {
"$ref" : "#/definitions/edwResponseItem"
}
}
},
"summary" : "Cancel an existing Eulerian Data Warehouse Analysis.",
"tags" : [
"EDW-Jobs"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}/cancel\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}/cancel',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}/cancel');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.edw.eulerian.{datacenter}/edw/jobs/{jobid}/cancel', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/authtree.json" : {
"get" : {
"description" : "This API allows you to recover all the information from data sources to which you have access according to your user profile.\n\n```\n{\n \"meta\" : {},\n \"error\" : false,\n \"data\" : {\n \"1:509\" : {\n \"view\" : [\n {\n \"view_id\" : 0,\n \"view_dflt\" : \"Y\",\n \"view_name\" : \"Last channel\"\n }\n ],\n \"website_name\" : \"preprod-test1\",\n \"report\" : [\n {\n \"id\" : \"rh-1\",\n \"uuid\" : \"dashboard\",\n \"children\" : [\n {\n \"text\" : \"acquisition\",\n \"type\" : \"report\",\n \"uuid\" : \"insummary\",\n \"id\" : \"29\"\n },\n {\n \"type\" : \"report\",\n \"id\" : \"30\",\n \"uuid\" : \"insales\",\n \"text\" : \"sales\"\n },\n {\n \"type\" : \"report\",\n \"id\" : \"31\",\n \"uuid\" : \"inaudience\",\n \"text\" : \"origin\"\n },\n {\n \"type\" : \"report\",\n \"id\" : \"56\",\n \"uuid\" : \"website\",\n \"text\" : \"website\"\n }\n ],\n \"type\" : \"reportheading\",\n \"text\" : \"dashboards\"\n },\n {\n \"type\" : \"reportheading\",\n \"id\" : \"rh-2\",\n \"uuid\" : \"in\",\n \"children\" : [\n {\n \"text\" : \"display\",\n \"type\" : \"report\",\n \"uuid\" : \"inadvertising\",\n \"id\" : \"42\"\n },\n {\n \"uuid\" : \"inaffiliation\",\n \"id\" : \"43\",\n \"type\" : \"report\",\n \"text\" : \"affiliate\"\n }\n ]\n }\n ]\n }\n }\n}\n```\n\nThis reponse contains for each website you have access too :\n- the list of attribution rules in the **view** entry\n- the list of reports in the **report** entry\n- information of the current **website**\n\nThe content of the response contains :\n* **text**: the name of the report as it appears in the Eulerian reporting interface.\n* **type**: the two possible values are report and reportheading. Only the entries belonging to the report type correspond to reports containing data.\n* **id**: the internal id of the report as defined in our system (internal use only)\n* **uuid**: the internal key identifying the Eulerian report. It is the value that must replace $DATASOURCE in the examples provided in this [Analytics > Reporting: real-time](#tag/Reporting:-real-time).\n\n",
"operationId" : "authtreeAccount",
"parameters" : [],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Retrieve the authorization tree.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/authtree.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/authtree.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/authtree.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/authtree.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/billing.json" : {
"get" : {
"description" : "This query returns the billing information linked to the webmaster account sending the request.",
"operationId" : "billingAccount",
"parameters" : [
{
"description" : "date & year for which you want the billing, format=MM-YYYY.",
"example" : "04-2019",
"in" : "query",
"name" : "date",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "hit"
},
{
"name" : "view"
},
{
"name" : "bpromoclick"
},
{
"name" : "adview_ec"
},
{
"name" : "click"
},
{
"name" : "heatmap"
},
{
"name" : "rtd"
},
{
"name" : "bpromoview"
},
{
"name" : "clickout"
},
{
"name" : "grid_id"
},
{
"name" : "hit_click"
},
{
"name" : "total"
},
{
"name" : "multiview"
},
{
"name" : "content"
},
{
"name" : "website_name"
},
{
"name" : "website_id"
},
{
"name" : "grid_name"
}
],
"rows" : [
[
740706,
0,
0,
0,
164642,
1,
0,
73192,
1780,
"1",
905348,
980320,
6,
0,
"site1",
"529",
"fr"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Billing information for a given webmaster account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/billing.json?date=04-2019\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/billing.json?date=04-2019',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/billing.json?date=04-2019');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'date=04-2019'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/billing.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/get_dw_access_token.json" : {
"get" : {
"description" : "This query returns a static access_token to create calls to the Real-Time DataWareHouse API. The token is linked to the website that are authorized for your token. You will need to provide the IP that will be used to generate the requests on the Real-Time DataWareHouse, otherwise access will not be granted. To simplify dynamic IP management access, you can provide the IP following the format : DIGITS.DIGITS.DIGITS.X (eg: 165.23.65.X) or DIGITS.DIGITS.X.X (eg: 165.23.X.X), however we do not recommend this, in case you IP changes regurarly please use the ``get_dw_session_token`` method. To access the Real-Time DataWareHouse you will need to provide the Authorization HTTP Header, example: `Authorization: Bearer $SESSION_TOKEN`",
"operationId" : "getDwAccessTokenAccount",
"parameters" : [
{
"description" : "list of IPs separated by commas.",
"example" : "152.18.1.1,137.5.7.1",
"in" : "query",
"name" : "ip",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "access_token"
},
{
"name" : "ip"
},
{
"name" : "websites"
}
],
"rows" : [
[
"DEQwyRw987654dfsdfm_8YpRfjMNTih22j30BzNouDn0aEB4Sh9u8.AvI3s5KN8o1nElA1j.z6T.V7vJHRmnQ--",
"^(152.18.1.1|137.5.7.1)$",
"demo-fr,demo-en"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get an access token for realtime DW.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_access_token.json?ip=152.18.1.1%2C137.5.7.1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_access_token.json?ip=152.18.1.1,137.5.7.1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_access_token.json?ip=152.18.1.1,137.5.7.1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'ip=152.18.1.1%2C137.5.7.1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_access_token.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/get_dw_session_token.json" : {
"get" : {
"description" : "This query returns a temporary session_token to create calls to the Real-Time DataWareHouse API. The expiration value is provided in the response, the token is linked to the website that are authorized for your token. You will need to provide the IP that will be used to generate the requests on the Real-Time DataWareHouse, otherwise access will not be granted. To access the Real-Time DataWareHouse you will need to provide the Authorization HTTP Header, example: `Authorization: Bearer $SESSION_TOKEN`",
"operationId" : "getDwSessionTokenAccount",
"parameters" : [
{
"description" : "list of IPs separated by commas.",
"example" : "17.1.1.1,132.128.1.1",
"in" : "query",
"name" : "ip",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "session_token"
},
{
"name" : "expires_in"
},
{
"name" : "ip"
},
{
"name" : "websites"
}
],
"rows" : [
[
"DEQwyRw987654dfsdfm_8YpRfjMNTih22j30BzNouDn0aEB4Sh9u8.AvI3s5KN8o1nElA1j.z6T.V7vJHRmnQ--",
3600,
"^(17.1.1.1|132.128.1.1)$",
"demo-fr,demo-en"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a session token with expire date for realtime DW.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_session_token.json?ip=17.1.1.1%2C132.128.1.1\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_session_token.json?ip=17.1.1.1,132.128.1.1',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_session_token.json?ip=17.1.1.1,132.128.1.1');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'ip=17.1.1.1%2C132.128.1.1'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_dw_session_token.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/get_kafka_session_token.json" : {
"get" : {
"description" : "This query returns a temporary session_token to enable the injection of real-time userparam data from a Kafka server-side integration.",
"operationId" : "getKafkaSessionTokenAccount",
"parameters" : [
{
"default" : "IP from the originating server making the current call.",
"description" : "list of IPs separated by commas.",
"example" : "212.80.181.11,58.65.1.130",
"in" : "query",
"name" : "ip",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the site you want to target for data-injection",
"example" : "eulerian-corp",
"in" : "query",
"name" : "website-name",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "session_token"
},
{
"name" : "expires_in"
},
{
"name" : "ip"
}
],
"rows" : [
[
"DEQwyRw987654dfsdfm_8YpRfjMNTih22j30BzNouDn0aEB4Sh9u8.AvI3s5KN8o1nElA1j.z6T.V7vJHRmnQ--",
3600,
"^(212.80.181.11|58.65.1.130)$"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get a session token with expire date for realtime Kafka injection.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_kafka_session_token.json?ip=212.80.181.11%2C58.65.1.130&website-name=eulerian-corp\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_kafka_session_token.json?ip=212.80.181.11,58.65.1.130&website-name=eulerian-corp',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_kafka_session_token.json?ip=212.80.181.11,58.65.1.130&website-name=eulerian-corp');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'ip=212.80.181.11%2C58.65.1.130&website-name=eulerian-corp'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/get_kafka_session_token.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/getallowedwebsite.json" : {
"get" : {
"description" : "This query returns the list of websites that your current API Token allows you to query. It also provides the grid_id that you could have to provide to the endpoint if you have access to multiple grids.",
"operationId" : "getallowedwebsiteAccount",
"parameters" : [],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "grid_id"
},
{
"name" : "grid_name"
},
{
"name" : "website_id"
},
{
"name" : "website_name"
},
{
"name" : "website_tzone"
}
],
"rows" : [
[
"1",
"fr",
"19",
"demo-es",
"Europe/Madrid"
],
[
"1",
"fr",
"28",
"demo-fr",
"Europe/Paris"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 2
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Return list of websites you are authorized to access with your current account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getallowedwebsite.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getallowedwebsite.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getallowedwebsite.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getallowedwebsite.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/getreplaytoken.json" : {
"get" : {
"description" : "The purpose of this query is to retrieve a replay token, allowing you to inject data for past events for specific event calls, like sales, estimates, etc ...\n\nThe token is to be provided to `ereplay-aes` parameter on corresponding calls.\n\n> Once the date specified in **expires** is passed no data will be injected.",
"operationId" : "getreplaytokenAccount",
"parameters" : [],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "token"
},
{
"name" : "expires"
}
],
"rows" : [
[
"fyeBdCM6QoBcs5K5Su.7wF.Pvy66544DFDF-85DF--",
1777651390
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Retrieve the token for replay of data.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getreplaytoken.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getreplaytoken.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getreplaytoken.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getreplaytoken.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/getuserapitoken.json" : {
"get" : {
"description" : "This query returns a API token for a specific user, so that the user can use it to make calls on his behalf.",
"operationId" : "getuserapitokenAccount",
"parameters" : [
{
"description" : "account id for which you want the API token.",
"example" : 1777564990,
"in" : "query",
"name" : "account-id",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "token"
}
],
"rows" : [
[
"fyeBdCM6QoBcs5K5Su.7wF.Pvy66544DFDFDF--"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Return the API token for a user account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getuserapitoken.json?account-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getuserapitoken.json?account-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getuserapitoken.json?account-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'account-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/getuserapitoken.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/ping.json" : {
"get" : {
"description" : "This query will ping the API so that we know we have access to it. It is mostly used for the Microsoft Excel Plug-In.",
"operationId" : "pingAccount",
"parameters" : [
{
"description" : "id of the account to be targeted & pinged.",
"example" : 1777564990,
"in" : "query",
"name" : "account-id",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Ping the API so that we know we have access to it.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/ping.json?account-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/ping.json?account-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/ping.json?account-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'account-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/ping.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/pinguser.json" : {
"get" : {
"description" : "This query will ping the session of the provided user account. Authorization: webmaster only.",
"operationId" : "pinguserAccount",
"parameters" : [
{
"description" : "id of the account to be targeted & pinged.",
"example" : 1777564990,
"in" : "query",
"name" : "account-id",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Ping the session of the provided user account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/pinguser.json?account-id=1777564990\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/pinguser.json?account-id=1777564990',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/pinguser.json?account-id=1777564990');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'account-id=1777564990'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/pinguser.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/account/setuseractive.json" : {
"post" : {
"description" : "The purpose of this request is to enable the given user account.",
"operationId" : "setuseractiveAccount",
"parameters" : [
{
"description" : "account id for which you want to enable.",
"example" : 1777564990,
"in" : "query",
"name" : "account-id",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Enable a user account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"account-id=1777564990\" https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuseractive.json"
},
{
"lang" : "php",
"source" : " '1777564990'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuseractive.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuseractive.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('account-id=1777564990');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'account-id' : '1777564990'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/er/account/setuserapitoken.json" : {
"post" : {
"description" : "This query resets an API token for a specific user, so that the user can use it to make calls on his behalf.\n\n> This request cancels the old API token which becomes invalid , all new accesses generated with this old token will be refused.",
"operationId" : "setuserapitokenAccount",
"parameters" : [
{
"description" : "account id for which you want the reset to be done.",
"example" : 1777564990,
"in" : "query",
"name" : "account-id",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "token"
}
],
"rows" : [
[
"fyeBdCM6QoBcs5K5Su.7wF.Pvy66544DFDFDF--"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Reset the API token for a user account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"account-id=1777564990\" https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuserapitoken.json"
},
{
"lang" : "php",
"source" : " '1777564990'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuserapitoken.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuserapitoken.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('account-id=1777564990');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'account-id' : '1777564990'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/er/account/setuserinactive.json" : {
"post" : {
"description" : "The purpose of this request is to disable the given user account.",
"operationId" : "setuserinactiveAccount",
"parameters" : [
{
"description" : "account id for which you want to disable.",
"example" : 1777564990,
"in" : "query",
"name" : "account-id",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Disable a user account.",
"tags" : [
"Account"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"account-id=1777564990\" https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuserinactive.json"
},
{
"lang" : "php",
"source" : " '1777564990'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuserinactive.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/er/account/setuserinactive.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('account-id=1777564990');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'account-id' : '1777564990'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/er/cookiepedia/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.",
"operationId" : "searchCookiepedia",
"parameters" : [
{
"description" : "id of the cookiepedia",
"example" : 3,
"in" : "query",
"name" : "cookiepedia-id",
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the cookiepedia cookie",
"example" : "__utma",
"in" : "query",
"name" : "cookiepedia-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "must match the regexp /^(exact|contain|end|start)$/ default=start",
"example" : "contain",
"in" : "query",
"name" : "cookiepedia-name-like",
"schema" : {
"type" : "string"
}
},
{
"description" : "id of the cookiepediacompanytool",
"example" : "1",
"in" : "query",
"name" : "cookiepediacompanytool-id",
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "cookiepedia_name"
},
{
"name" : "cookiepedia_id"
},
{
"name" : "cookiepediacompanytool_id"
},
{
"name" : "cookiepedia_content"
}
],
"rows" : [
[
"__utma",
"1",
"1",
"{}"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Cookiepedia"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepedia/search.json?cookiepedia-id=3&cookiepedia-name=__utma&cookiepedia-name-like=contain&cookiepediacompanytool-id=1&dir=DESC&limit=25&start=0\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepedia/search.json?cookiepedia-id=3&cookiepedia-name=__utma&cookiepedia-name-like=contain&cookiepediacompanytool-id=1&dir=DESC&limit=25&start=0',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepedia/search.json?cookiepedia-id=3&cookiepedia-name=__utma&cookiepedia-name-like=contain&cookiepediacompanytool-id=1&dir=DESC&limit=25&start=0');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'cookiepedia-id=3&cookiepedia-name=__utma&cookiepedia-name-like=contain&cookiepediacompanytool-id=1&dir=DESC&limit=25&start=0'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepedia/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/cookiepediacompany/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.",
"operationId" : "searchCookiepediaCompany",
"parameters" : [
{
"description" : "name of the cookiepediacompany",
"example" : 3,
"in" : "query",
"name" : "cookiepediacompany-id",
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the cookiepediacompany",
"example" : "Facebook",
"in" : "query",
"name" : "cookiepediacompany-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "must match the regexp /^(exact|contain|end|start)$/ default=start",
"example" : "contain",
"in" : "query",
"name" : "cookiepediacompany-name-like",
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "cookiepediacompany_name"
},
{
"name" : "cookiepediacompany_id"
},
{
"name" : "cookiepediacompany_content"
}
],
"rows" : [
[
"Facebook",
"1",
"{}"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Cookiepedia Company"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompany/search.json?cookiepediacompany-id=3&cookiepediacompany-name=Facebook&cookiepediacompany-name-like=contain&dir=DESC&limit=25&start=0\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompany/search.json?cookiepediacompany-id=3&cookiepediacompany-name=Facebook&cookiepediacompany-name-like=contain&dir=DESC&limit=25&start=0',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompany/search.json?cookiepediacompany-id=3&cookiepediacompany-name=Facebook&cookiepediacompany-name-like=contain&dir=DESC&limit=25&start=0');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'cookiepediacompany-id=3&cookiepediacompany-name=Facebook&cookiepediacompany-name-like=contain&dir=DESC&limit=25&start=0'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompany/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/cookiepediacompanytool/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.",
"operationId" : "searchCookiepediaCompanyTool",
"parameters" : [
{
"description" : "id of the cookiepediacompany",
"example" : "1",
"in" : "query",
"name" : "cookiepediacompany-id",
"schema" : {
"type" : "string"
}
},
{
"description" : "id of the cookiepediacompanytool",
"example" : 3,
"in" : "query",
"name" : "cookiepediacompanytool-id",
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the cookiepediacompanytool",
"example" : "Facebook",
"in" : "query",
"name" : "cookiepediacompanytool-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "must match the regexp /^(exact|contain|end|start)$/ default=start",
"example" : "contain",
"in" : "query",
"name" : "cookiepediacompanytool-name-like",
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "cookiepediacompanytool_name"
},
{
"name" : "cookiepediacompanytool_id"
},
{
"name" : "cookiepediacompany_id"
},
{
"name" : "cookiepediacompanytool_content"
}
],
"rows" : [
[
"Facebook",
"1",
"1",
"{}"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"Cookiepedia Company Tool"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompanytool/search.json?cookiepediacompany-id=1&cookiepediacompanytool-id=3&cookiepediacompanytool-name=Facebook&cookiepediacompanytool-name-like=contain&dir=DESC&limit=25&start=0\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompanytool/search.json?cookiepediacompany-id=1&cookiepediacompanytool-id=3&cookiepediacompanytool-name=Facebook&cookiepediacompanytool-name-like=contain&dir=DESC&limit=25&start=0',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompanytool/search.json?cookiepediacompany-id=1&cookiepediacompanytool-id=3&cookiepediacompanytool-name=Facebook&cookiepediacompanytool-name-like=contain&dir=DESC&limit=25&start=0');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'cookiepediacompany-id=1&cookiepediacompanytool-id=3&cookiepediacompanytool-name=Facebook&cookiepediacompanytool-name-like=contain&dir=DESC&limit=25&start=0'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/cookiepediacompanytool/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/websitegrid-overridepo/create.json" : {
"post" : {
"description" : "This query allows for creating a new override for a given PO key in a given language. Authorization: webmaster only.",
"operationId" : "createOverrideText",
"parameters" : [
{
"description" : "Id of the websitegrid you are working on.",
"example" : 19,
"in" : "path",
"name" : "websitegrid-id",
"required" : true,
"schema" : {
"type" : "integer"
}
},
{
"description" : "po key of the text you want to check.",
"example" : "var.visit",
"in" : "query",
"name" : "overridepo-po",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "new text to override for the given key in given language.",
"example" : "my new visit text",
"in" : "query",
"name" : "overridepo-txt",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "language key for the po key of the text you want to check.",
"example" : "fr",
"in" : "query",
"name" : "lang-key",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "overridepo_id"
},
{
"name" : "overridepo_po"
},
{
"name" : "overridepo_txt"
}
],
"rows" : [
[
32,
"var.visit",
"mes visites"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Create a new override.",
"tags" : [
"Over-ride Text"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"lang-key=fr&overridepo-po=var.visit&overridepo-txt=my%20new%20visit%20text\" https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/create.json"
},
{
"lang" : "php",
"source" : " 'fr',\n'overridepo-po' => 'var.visit',\n'overridepo-txt' => 'my new visit text'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/create.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/create.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('lang-key=fr&overridepo-po=var.visit&overridepo-txt=my%20new%20visit%20text');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'lang-key' : 'fr',\n'overridepo-po' : 'var.visit',\n'overridepo-txt' : 'my%20new%20visit%20text'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/er/websitegrid-overridepo/exists.json" : {
"get" : {
"description" : "This query will check if an overriden text exists for a given PO & language.",
"operationId" : "existsOverrideText",
"parameters" : [
{
"description" : "language key for the po key of the text you want to check.",
"example" : "fr",
"in" : "query",
"name" : "lang-key",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "po key of the text you want to check.",
"example" : "var.visit",
"in" : "query",
"name" : "overridepo-po",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Id of the websitegrid you are working on.",
"example" : 19,
"in" : "path",
"name" : "websitegrid-id",
"required" : true,
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "overridepo_id"
}
],
"rows" : [
[
116
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Check if a override PO exists",
"tags" : [
"Over-ride Text"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/exists.json?lang-key=fr&overridepo-po=var.visit\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/exists.json?lang-key=fr&overridepo-po=var.visit',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/exists.json?lang-key=fr&overridepo-po=var.visit');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'lang-key=fr&overridepo-po=var.visit'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/exists.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/websitegrid-overridepo/get_mapping.json" : {
"get" : {
"description" : "Given a language key, this query will return all the allowed PO keys for override and will provide the existing overrides for each key.",
"operationId" : "getMappingOverrideText",
"parameters" : [
{
"description" : "language key for which you want the full mapping.",
"example" : "fr",
"in" : "query",
"name" : "lang-key",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Id of the websitegrid you are working on.",
"example" : 19,
"in" : "path",
"name" : "websitegrid-id",
"required" : true,
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "global_po"
},
{
"name" : "global_txt"
},
{
"name" : "overridepo_id"
},
{
"name" : "overridepo_txt"
}
],
"rows" : [
[
"var.tpclickext",
"clics sortants étendus",
456,
"mes clics"
],
[
"var.ratio_kgoalrealestimatevalidmargin",
"objectif marge devis réelle par type",
"",
""
],
[
"var.vrvisit_visit.short",
"tx revisite",
"",
""
],
[
"var.vcoldvisitor",
"anciens VU (post-clic)",
"",
""
],
[
"var.vcrpropertyduration.short",
"prop. temps passé (pi/pc/rv)",
"",
""
],
[
"var.vrnewcustomer.short",
"nvx cli. (rv)",
"",
""
],
[
"var.click.short",
"clics",
"",
""
],
[
"var.vrvisitpprofile",
"visites par profil (revisite)",
"",
""
],
[
"var.realscartvalidamount_visit.short",
"CA réel/vis.",
"",
""
],
[
"var.visitin.short",
"vis. Entrantes",
"",
""
],
[
"global.media.paidinclusion",
"paid inclusion",
8965,
"New Paid Inclusion Channel"
],
[
"var.vcrestimatevalidamount",
"CA devis (post-impression/post-clic/revisite)",
"",
""
],
[
"var.scartvalidunique_scartvalid",
"% de vente réacheteurs",
"",
""
],
[
"var.vcrscartvalidamount.short",
"CA (pi/pc/rv)",
"",
""
],
[
"var.clickoutsession_viewoutsession",
"clics sortants/impressions sortantes session",
"",
""
],
[
"var.durationpvisit",
"visites par temps passé",
"",
""
],
[
"global.media.sponsoredlinkwobs",
"liens sponsorisés (hors branding)",
"",
""
],
[
"var.vcrhitpvisit",
"nombre de visites par nombre minimum de pages vues (post-impression/post-clic/revisite)",
"",
""
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 18
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get the mapping for a language",
"tags" : [
"Over-ride Text"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/get_mapping.json?lang-key=fr\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/get_mapping.json?lang-key=fr',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/get_mapping.json?lang-key=fr');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'lang-key=fr'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/get_mapping.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/websitegrid-overridepo/purge.json" : {
"delete" : {
"description" : "This query will purge all entries for all the languages. Authorization: webmaster only.",
"operationId" : "purgeOverrideText",
"parameters" : [
{
"description" : "Id of the websitegrid you are working on.",
"example" : 19,
"in" : "path",
"name" : "websitegrid-id",
"required" : true,
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Purge all the overridden PO keys for all languages.",
"tags" : [
"Over-ride Text"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X DELETE \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/purge.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/purge.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/purge.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/purge.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/websitegrid-overridepo/remove.json" : {
"delete" : {
"description" : "This query allows for deleting an existing override key. Authorization: webmaster only.",
"operationId" : "removeOverrideText",
"parameters" : [
{
"description" : "id of the override PO you want to remove.",
"example" : 563,
"in" : "query",
"name" : "overridepo-id",
"required" : true,
"schema" : {
"type" : "integer"
}
},
{
"description" : "Id of the websitegrid you are working on.",
"example" : 19,
"in" : "path",
"name" : "websitegrid-id",
"required" : true,
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [],
"rows" : []
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 0
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Remove an existing overriden PO key.",
"tags" : [
"Over-ride Text"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X DELETE \"https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/remove.json?overridepo-id=563\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/remove.json?overridepo-id=563',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/remove.json?overridepo-id=563');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'overridepo-id=563'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/remove.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/er/websitegrid-overridepo/update.json" : {
"post" : {
"description" : "This query allows for updating an existing override key. Authorization: webmaster only.",
"operationId" : "updateOverrideText",
"parameters" : [
{
"description" : "Id of the websitegrid you are working on.",
"example" : 19,
"in" : "path",
"name" : "websitegrid-id",
"required" : true,
"schema" : {
"type" : "integer"
}
},
{
"description" : "id of the override PO you want to update.",
"example" : 563,
"in" : "query",
"name" : "overridepo-id",
"required" : true,
"schema" : {
"type" : "integer"
}
},
{
"description" : "new text to override for the given key in given language.",
"example" : "my new visit text",
"in" : "query",
"name" : "overridepo-txt",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "overridepo_id"
}
],
"rows" : [
[
116
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Update an existing overriden PO key.",
"tags" : [
"Over-ride Text"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"overridepo-id=563&overridepo-txt=my%20new%20visit%20text\" https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/update.json"
},
{
"lang" : "php",
"source" : " '563',\n'overridepo-txt' => 'my new visit text'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/update.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/er/websitegrid-overridepo/update.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('overridepo-id=563&overridepo-txt=my%20new%20visit%20text');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'overridepo-id' : '563',\n'overridepo-txt' : 'my%20new%20visit%20text'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/marketplace/datamember/get_me.json" : {
"get" : {
"description" : "This query will retrieve all the information related to the current datamember.",
"operationId" : "getMeDataMember",
"parameters" : [],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "datamember_id"
},
{
"name" : "datamember_name"
},
{
"name" : "datamember_provider"
},
{
"name" : "datamember_subscriber"
}
],
"rows" : [
[
"11",
"My DataMember",
"Y",
"N"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Get information about current datamember.",
"tags" : [
"DataMember"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/get_me.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/get_me.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/get_me.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/get_me.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/marketplace/datamember/update.json" : {
"post" : {
"description" : "This query allows for updating an existing datamember. Authorization: webmaster only.",
"operationId" : "updateDataMember",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "id of the datamember for which you want to modify attributes",
"example" : 1777564990,
"in" : "query",
"name" : "datamember-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "new datamember name",
"example" : "New name",
"in" : "query",
"name" : "datamember-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to modify the subscriber attribute",
"example" : "Y",
"in" : "query",
"name" : "datamember-subscriber",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to modify the provider attribute",
"example" : "Y",
"in" : "query",
"name" : "datamember-provider",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "datamember_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Update an existing datamember.",
"tags" : [
"DataMember"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"datamember-id=1777564990&datamember-name=New%20name&datamember-provider=Y&datamember-subscriber=Y\" https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/update.json"
},
{
"lang" : "php",
"source" : " '1777564990',\n'datamember-name' => 'New name',\n'datamember-provider' => 'Y',\n'datamember-subscriber' => 'Y'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/update.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamember/update.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('datamember-id=1777564990&datamember-name=New%20name&datamember-provider=Y&datamember-subscriber=Y');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'datamember-id' : '1777564990',\n'datamember-name' : 'New%20name',\n'datamember-provider' : 'Y',\n'datamember-subscriber' : 'Y'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/marketplace/datamemberwebsitegrid/create.json" : {
"post" : {
"description" : "This query allows for the current datamember to set-up a new datamember website either has a provider, subscriber or both. Afterwards the specified website will be able to provide or subscribe to shared segments. Authorization: webmaster only.",
"operationId" : "createDataMemberWebsite",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the website to create",
"example" : "my-website-name",
"in" : "query",
"name" : "website-name",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "datamemberwebsitegrid name, by default will be the name of the website.",
"example" : "my-dmwg-name",
"in" : "query",
"name" : "datamemberwebsitegrid-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to modify the subscriber attribute",
"example" : "Y",
"in" : "query",
"name" : "datamemberwebsitegrid-subscriber",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to modify the provider attribute",
"example" : "Y",
"in" : "query",
"name" : "datamemberwebsitegrid-provider",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "datamemberwebsitegrid_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Create a new datamember website.",
"tags" : [
"DataMember Website"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"datamemberwebsitegrid-name=my-dmwg-name&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y&website-name=my-website-name\" https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/create.json"
},
{
"lang" : "php",
"source" : " 'my-dmwg-name',\n'datamemberwebsitegrid-provider' => 'Y',\n'datamemberwebsitegrid-subscriber' => 'Y',\n'website-name' => 'my-website-name'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/create.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/create.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('datamemberwebsitegrid-name=my-dmwg-name&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y&website-name=my-website-name');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'datamemberwebsitegrid-name' : 'my-dmwg-name',\n'datamemberwebsitegrid-provider' : 'Y',\n'datamemberwebsitegrid-subscriber' : 'Y',\n'website-name' : 'my-website-name'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/marketplace/datamemberwebsitegrid/make_ebmdbreqshared_available_for_subscriber.json" : {
"post" : {
"description" : "This query allows for initiating the sharing process of a provider shared segment to a target subscriber. Authorization: webmaster only.",
"operationId" : "makeEbmdbreqsharedAvailableForSubscriberDataMemberWebsite",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the provider website owning the shared segment. The datamember must have access to this website.",
"example" : "my-provider-website-name",
"in" : "query",
"name" : "provider-website-name",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "id of the shared segment from the provider website.",
"example" : 1777564990,
"in" : "query",
"name" : "ebmdbreqshared-id",
"schema" : {
"type" : "string"
}
},
{
"description" : "name of the subscriber website to which the segment is going to be shared.",
"example" : "my-subscriber-website-name",
"in" : "query",
"name" : "subscriber-website-name",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "if the subscriber is not the same as the provider, for example another site on another grid, you need to specify the source of the subscriber.",
"example" : 2,
"in" : "query",
"name" : "subscriber-datamember-id",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "ebmdbreqsharedtarget_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Share a segment to a subscriber website.",
"tags" : [
"DataMember Website"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"ebmdbreqshared-id=1777564990&provider-website-name=my-provider-website-name&subscriber-datamember-id=2&subscriber-website-name=my-subscriber-website-name\" https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/make_ebmdbreqshared_available_for_subscriber.json"
},
{
"lang" : "php",
"source" : " '1777564990',\n'provider-website-name' => 'my-provider-website-name',\n'subscriber-datamember-id' => '2',\n'subscriber-website-name' => 'my-subscriber-website-name'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/make_ebmdbreqshared_available_for_subscriber.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/make_ebmdbreqshared_available_for_subscriber.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('ebmdbreqshared-id=1777564990&provider-website-name=my-provider-website-name&subscriber-datamember-id=2&subscriber-website-name=my-subscriber-website-name');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'ebmdbreqshared-id' : '1777564990',\n'provider-website-name' : 'my-provider-website-name',\n'subscriber-datamember-id' : '2',\n'subscriber-website-name' : 'my-subscriber-website-name'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
},
"/marketplace/datamemberwebsitegrid/search.json" : {
"get" : {
"description" : "This query allows for searching through filtering parameters & pagination.",
"operationId" : "searchDataMemberWebsite",
"parameters" : [
{
"description" : "name of the datamemberwebsitegrid",
"example" : "my-test-datamemberwebsitegrid",
"in" : "query",
"name" : "datamemberwebsitegrid-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to 1 if you want it to be exact, otherwise it is \"start by\"",
"example" : 1,
"in" : "query",
"name" : "datamemberwebsitegrid-name-exact",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to filter on provider flag",
"example" : "Y",
"in" : "query",
"name" : "datamemberwebsitegrid-provider",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to filter on subscriber flag",
"example" : "Y",
"in" : "query",
"name" : "datamemberwebsitegrid-subscriber",
"schema" : {
"type" : "string"
}
},
{
"description" : "direction for sorting : ASC or DESC",
"enum" : [
"ASC",
"DESC"
],
"example" : "DESC",
"in" : "query",
"name" : "dir",
"schema" : {
"type" : "string"
}
},
{
"description" : "the numbers of items to return",
"example" : 25,
"in" : "query",
"name" : "limit",
"schema" : {
"type" : "integer"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "the number of items to skip before starting to collect the result set",
"example" : 0,
"in" : "query",
"name" : "start",
"schema" : {
"type" : "integer"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "datamemberwebsitegrid_id"
},
{
"name" : "datamemberwebsitegrid_name"
},
{
"name" : "datamemberwebsitegrid_provider"
},
{
"name" : "datamemberwebsitegrid_subscriber"
}
],
"rows" : [
[
"1",
"my-website",
"Y",
"N"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Search & filter through all available entries.",
"tags" : [
"DataMember Website"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/search.json?datamemberwebsitegrid-name=my-test-datamemberwebsitegrid&datamemberwebsitegrid-name-exact=1&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y&dir=DESC&limit=25&start=0\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/search.json?datamemberwebsitegrid-name=my-test-datamemberwebsitegrid&datamemberwebsitegrid-name-exact=1&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y&dir=DESC&limit=25&start=0',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/search.json?datamemberwebsitegrid-name=my-test-datamemberwebsitegrid&datamemberwebsitegrid-name-exact=1&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y&dir=DESC&limit=25&start=0');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = 'datamemberwebsitegrid-name=my-test-datamemberwebsitegrid&datamemberwebsitegrid-name-exact=1&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y&dir=DESC&limit=25&start=0'\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/search.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/marketplace/datamemberwebsitegrid/update.json" : {
"post" : {
"description" : "This query allows for updating an existing datamemberwebsitegrid. Authorization: webmaster only.",
"operationId" : "updateDataMemberWebsite",
"parameters" : [
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "id of the datamemberwebsitegrid for which you want to modify attributes",
"example" : 1777564990,
"in" : "query",
"name" : "datamemberwebsitegrid-id",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "new datamemberwebsitegrid name",
"example" : "New name",
"in" : "query",
"name" : "datamemberwebsitegrid-name",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to modify the subscriber attribute",
"example" : "Y",
"in" : "query",
"name" : "datamemberwebsitegrid-subscriber",
"schema" : {
"type" : "string"
}
},
{
"description" : "set to Y or N to modify the provider attribute",
"example" : "Y",
"in" : "query",
"name" : "datamemberwebsitegrid-provider",
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : [
{
"name" : "datamemberwebsitegrid_id"
}
],
"rows" : [
[
1777564990
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564990108471777564990",
"start" : 0,
"tm" : 1777564990,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK",
"links" : {
"searchDataMemberWebsite" : {
"description" : "Use the value of datamemberwebsitegrid_id entry to update a datamemberwebsitegrid through datamemberwebsitegrid-id parameter.",
"operationId" : "searchDataMemberWebsite",
"parameters" : {
"datamemberwebsitegrid-id" : "$response.body#/data/rows/0/0"
}
}
}
}
},
"summary" : "Update an existing datamemberwebsitegrid.",
"tags" : [
"DataMember Website"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X POST -d \"datamemberwebsitegrid-id=1777564990&datamemberwebsitegrid-name=New%20name&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y\" https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/update.json"
},
{
"lang" : "php",
"source" : " '1777564990',\n'datamemberwebsitegrid-name' => 'New name',\n'datamemberwebsitegrid-provider' => 'Y',\n'datamemberwebsitegrid-subscriber' => 'Y'\n];\n$defaults = array(\n CURLOPT_URL => 'https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/update.json',\n CURLOPT_POST => 1,\n CURLOPT_POSTFIELDS => http_build_query($params),\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nrequire HTTP::Request;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\nmy $req = new HTTP::Request('POST','https://{customer}.api.eulerian.{datacenter}/ea/v2/marketplace/datamemberwebsitegrid/update.json');\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\n$req->content_type('application/x-www-form-urlencoded');\n$req->content('datamemberwebsitegrid-id=1777564990&datamemberwebsitegrid-name=New%20name&datamemberwebsitegrid-provider=Y&datamemberwebsitegrid-subscriber=Y');\nmy $response = $ua->request( $req );\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\npayload = {\n 'datamemberwebsitegrid-id' : '1777564990',\n'datamemberwebsitegrid-name' : 'New%20name',\n'datamemberwebsitegrid-provider' : 'Y',\n'datamemberwebsitegrid-subscriber' : 'Y'\n\n}\nresponse = requests.post(endpoint, json=payload, headers ={'content-type': 'application/json', 'authorization':'Bearer {apitoken}'})\nprint(response.json())\n"
}
]
}
}
},
"security" : [
{
"BearerAuth" : []
}
],
"servers" : [
{
"description" : "API host for issuing requests to",
"url" : "https://{customer}.api.eulerian.{datacenter}/ea/v2",
"variables" : {
"customer" : {
"default" : "$YOUR_CUSTOMER_DOMAIN",
"description" : "Your customer reporting domain name"
},
"datacenter" : {
"default" : "com",
"description" : "The platform/datacenter you must target",
"enum" : [
"com",
"ca"
]
}
}
}
],
"tags" : [
{
"description" : "API for managing information about your account.",
"name" : "Account"
},
{
"description" : "This API allows you to manage the list of actionlabel1\"s that can be linked to any given action.",
"name" : "ActionLabel1"
},
{
"description" : "This API allows you to manage the list of actionlabel2\"s that can be linked to any given action.",
"name" : "ActionLabel2"
},
{
"description" : "This API allows you to manage the list of actionlabel3\"s that can be linked to any given action.",
"name" : "ActionLabel3"
},
{
"description" : "This API allows you to manage the list of actionlabel4\"s that can be linked to any given action.",
"name" : "ActionLabel4"
},
{
"description" : "This API allows you to manage the list of actionlabel5\"s that can be linked to any given action.",
"name" : "ActionLabel5"
},
{
"description" : "This API allows you to manage the adhoc jobs for a given website.",
"name" : "Adhoc"
},
{
"description" : "This API allows you to manage the audiences in which you'll be able to create clustervalues. You'll be able to access analytics reports and use the cluster for DMP activation.",
"name" : "Audience"
},
{
"description" : "This API allows you to work with the audience engine and provides methods for requesting data generated by the audience engine.",
"name" : "Audience Engine"
},
{
"description" : "This API allows you to manage the autoreports for a given website.",
"name" : "AutoReport"
},
{
"description" : "This API allows you to send batch reporting request to the reporting engine. Depending on the `kind` of the report the query `request` and response will be different. Below is explained the real-time type of query.\n\n\nYou can check the Postman examples - https://documenter.getpostman.com/view/15399981/2s93JqSQgY.\n\n### Specific cases\n\n#### Dimension Explorer\n\n**WARNING** : data for the **current day** is never available.\n\nWhen you want to request data from the Dimension Explorer feature you need :\n* to know which dimensions you want to query it is provided in the `field` property which is the exact name of the dimension\n* to use the specific `rt#dewebsite` kind\n\nYou can provide multiple dimensions to deduplicate the data and thus have access to very granular information as long as the dimension have been declared.\n```\n\"dimensions\" : [\n { \"name\" : \"dimension pagegroup\", \"field\" : \"PageGroup\" },\n { \"name\" : \"dimension actionlabel1\", \"field\" : \"ActionLabel1\" },\n { \"name\" : \"dimension pagelabel5\", \"field\" : \"PageLabel5\" },\n { \"name\" : \"dimension ordertype\", \"field\" : \"OrderType\" },\n],\n```\nWill deduplicate all the entries between them.\n\n#### Segmenting\n\nFor specific metrics you can have the ability to segment the metric in subsets.\nYou can segment :\n* sales metrics for `kind` providing sales metrics per `ordertype`, `orderpayment`, `geoloc`, `shop`\n* estimates metrics for `kind` providing estimates metrics per `estimatetype`, `geoloc`, `shop`\n* action metrics for `kind` providing action metrics per `action`\n* landing page for `kind = \"rt#landing\"` metrics per `pagegroup`, `pageinfo`\n\n",
"name" : "Batch Reporting"
},
{
"description" : "This API allows you to manage the campaigns sending trafic to your website.\n\n\n### Third-party data import: click, impression, cost/adspend\n\nIt is possible to import the clicks, impressions and budgets data for any paid campaign declared in Eulerian.\nThe file structure will vary depending on the context and the channel. You will find below a sample CSV file structure :\n\n```\nea:date;ea:ope;ea:clickthruurl;ea:location;ea:creative;ea:product;ea:external_view;ea:external_click;ea:external_cost\n2016-12-25;nom_de_la_campagne1;http://site-de-destination.com;generic;clearpix;ABC123;2000;500;120.54\n2016-04-08;nom_de_la_campagne2;http://site-de-destination.com;homepage;banniere;produit1;1500;250;89.45\n```\n#### File specification\n* the file has `.csv` extension\n* the fils is a CSV file format\n* the file must be sent via a `POST` call to the appropriate URL.\n* the separator to be used is the **semi-colon (;)**.\n* the columns `ea:ope` / `ea:location` / `ea:creative` / `ea:product` must exist to be applied\n* the file's first line must contain the columns according to the type of upload.\n* the file must be encoded in **UTF-8**.\n* the file size limit is set to **5Mo**.\n* the data will not be distributed throughout the day but injected at midday according to the time zone of the site.\n\n#### Columns specifications\n![](\"//dem.eulerian.net/dynview/demo-fr/1777564992?ead-publisher=amazon&ead-name=amz-{%campaign_cfid}&ead-location=amz-{%ad_cfid}-1x1&ead-creative=amz-{%creative_cfid}-1x1&ead-creativetype=1x1&eseg-name=esegname&eseg-item=esegitem&ea-rnd={%random}&gdpr=${GDPR}&gdpr_pd=${GDPR_PD}&gdpr_consent=${GDPR_CONSENT_413}\")
"
]
]
},
"error" : false,
"error_code" : "ERROR_CODE",
"error_msg" : "ERROR_MSG",
"meta" : {
"elapsed" : "0.235",
"host" : "er11",
"pid" : 10847,
"reqid" : "1777564992108471777564992",
"start" : 0,
"tm" : 1777564992,
"total" : 1
}
},
"schema" : {
"$ref" : "#/components/schemas/StandardAPIResponse"
}
}
},
"description" : "OK"
}
},
"summary" : "Tracking links for Amazon",
"tags" : [
"Trafficking"
],
"x-codeSamples" : [
{
"lang" : "curl",
"source" : "curl -H 'Authorization: Bearer {apitoken}' -X GET \"https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/db/trafficking/get_amazon.json\""
},
{
"lang" : "php",
"source" : " 'https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/db/trafficking/get_amazon.json',\n CURLOPT_RETURNTRANSFER => 1,\n CURLOPT_HTTPHEADER => array('Authorization: Bearer {apitoken}')\n);\ncurl_setopt_array($curl, $defaults);\n$resp = curl_exec($curl);\ncurl_close($curl);\n?>\n"
},
{
"lang" : "perl",
"source" : "require LWP::UserAgent;\nmy $ua = LWP::UserAgent->new;\n$ua->timeout(10);\n$ua->default_headers( 'Authorization' => 'Bearer {apitoken}' );\nmy $response = $ua->get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/db/trafficking/get_amazon.json');\n\nif ($response->is_success) {\n print $response->decoded_content;\n} else {\n die $response->status_line;\n}\n"
},
{
"lang" : "python",
"source" : "import requests\n\npayload = ''\nresponse = requests.get('https://{customer}.api.eulerian.{datacenter}/ea/v2/ea/{site}/db/trafficking/get_amazon.json', params=payload)\nprint(response.json())\n"
}
]
}
},
"/ea/{site}/db/trafficking/get_awin.json" : {
"get" : {
"description" : "This query allows you to fetch tracking links for AWin",
"externalDocs" : {
"description" : "Click here to try this method in our API Explorer!",
"url" : "https://eu.global-cdn.net/ea-ui/api/eulerian-db.html?class=trafficking&method=get_awin"
},
"operationId" : "getAwinTrafficking",
"parameters" : [
{
"default" : "!!!linkid!!!",
"description" : "Creative",
"in" : "query",
"name" : "creative",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"default" : "1x1",
"description" : "Creative type",
"in" : "query",
"name" : "creativetype",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"default" : "!!!companyname!!!",
"description" : "Inbound segment value",
"in" : "query",
"name" : "esegitem",
"schema" : {
"type" : "string"
}
},
{
"default" : "!!!promotype!!!",
"description" : "Inbound segment",
"in" : "query",
"name" : "esegname",
"schema" : {
"type" : "string"
}
},
{
"description" : "Landing page",
"in" : "query",
"name" : "eurl",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"default" : "PROGRAM_NAME",
"description" : "Campaign",
"in" : "query",
"name" : "ope",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"default" : "awin",
"description" : "Publisher",
"in" : "query",
"name" : "publisher",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"description" : "Site you are working on",
"example" : "my-website",
"in" : "path",
"name" : "site",
"required" : true,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"example" : {
"data" : {
"fields" : {
"click_url_redirect" : 2,
"click_url_withparams" : 1,
"platform_name" : 0,
"view_url" : 3
},
"rows" : [
[
"AWin",
"https://demo.fr/?eaf-publisher=awin&eaf-name=PROGRAM_NAME&eaf-creative=!!!linkid!!!&eaf-creativetype=1x1&eseg-name=!!!promotype!!!&eseg-item=!!!companyname!!!&awnid=!!!awc!!!",
"eaf-publisher=awin&eaf-name=PROGRAM_NAME&eaf-creative=!!!linkid!!!&eaf-creativetype=1x1&eseg-name=!!!promotype!!!&eseg-item=!!!companyname!!!&awnid=!!!awc!!!&eurl=https://demo.fr/&gdpr=${GDPR}&gdpr_pd=${GDPR_PD}&gdpr_consent=${GDPR_CONSENT_413}",
"