GET Conversion Details
GET Conversion Details
Returns the list of conversion details
Resource URL: GET /{version}/measure/conversiondetails/?site=XXXX&token=YYYY&date_start=YYYY-MM-DD&date_end=YYYY-MM-DD&format=ZZZZ
Parameters:
URI PARAMETER | TYPE | MANDATORY | DESCRIPTION |
version | Alphanum | Yes | Call API version |
URL PARAMETER | TYPE | MANDATORY | DESCRIPTION |
site | Integer | Yes | Client site identifier |
token | Alphanum | Yes | Caller security identifier |
date_start | Date | Yes | Data recovery start date (YYYY-MM-DD format) |
date_end | Date | Yes | Data recovery end date (YYYY-MM-DD format) |
attrib | Alphanum | No | Attribution models identifier (0 to look through all CJ) |
segment | Alphanum | No | Identifier of the segment that will be used to recover data |
attrib_operator | String | No | Selection operator for the channel and the source (in, notin) |
channel | Integer | No | Conversion containing this channel id |
source | String | No | Conversion containing this source |
order_ids | Alphanum | No | Order identifiers’ list, separated by commas |
amount | Numeric | No | Conversion amount |
amount_operator | String | No | Operator (eq, neq, lt, lte, gt, gte) for the conversion amount selection (Mandatory if amount is a parameter) |
touchpoint | Integer | No | Number of touchpoints |
touchpoint_operator | String | No | Operator (eq, neq, lt, lte, gt, gte) for the touchpoint amount selection (Mandatory if touchpoint is a parameter) |
fraud | String | No | Required score for fraud detection (any, good, average, bad) |
format | String | No | Response format (XML or JSON) – JSON by default |
page | Integer | No | Requested page – By default 0 |
count | Integer | No | Number of elements per page, cannot exceed 100; 100 by default |
include_cj | Integer | No | Include or not customer journeys (0 for no, 1 for yes) – 0 by default |
duplicated_conversions | Integer | No | Include or not duplicated conversions (0 for no, 1 for yes) – 0 by default |
excluded_conversions | Integer | No | Include or not excluded conversions (0 for no, 1 for yes) – 0 by default |
Return codes:
HTTP CODE | MESSAGE | DESCRIPTION |
200 | OK | The request went through, the result is in the answer’s body |
400 | Bad Request | The parameters are not ok or mandatory parameters are missing |
401 | Unauthorized | The security token does not match the site_id or the container_id |
500 | Internal Server Error | Internal server erros |
Response Format The response is in a JSON or XML format.
Difference between API and conversion details
API
List of fixed dimension in the API
Fixed dimensions
Traffic Dimensions on demand ( Jira ticket)
Conversions Dimensions populated in the conversion hit ( Conversions tags or Server Side tags)
List of fixed dimension in the Api :
tc_id
id_order
date
amount_order
score
channel_winner
source_winner
click_number
view_number
touch_point
time_convert
user_agent
ip
Export Conversion Details
List of fixed dimension in the Export
Fixed dimensions
Traffic Dimensions on demand ( ticket)
"raw" dimensions (= option keep format checked )
Conversion dimensions
List of fixed dimension in the Export:
Identifier ID
Order ID
Date
Amount
Fraud score
Winner Channel (one touch)
Winner Source (one touch)
Click
Impression
Touch points
Time to convert
Browser
IP
3 remarks:
API send the dimensions only when the information is available in the hit
Export send all the dimensions, when it’s empty it send null as a value in the export
Some names of the properties are not the same for the exports and the API ( tc_id / Identifier ID ; view_number / Impression ; etc...)
Last updated