# MixCommander v1 API ## GET Traffic Report Exports (deprecated, use live report builder API instead) Returns data from the interface’s reports **Resource URL:**\ GET /**{version}**/measure/reporttrafic/**{id\_type\_rapport}**?**site**=XXXX&**token**=YYYY&**date\_start**=YYYY-MM-DD&**date\_end**=YYYY-MM-DD&**attrib**=A,B,C&**kpis**=Q,S,D&**segment**=UUUU&**breakdown**=TTTT&**format**=ZZZZ **Parameters:** | URI PARAMETER | TYPE | MANDATORY | DESCRIPTION | | ----------------- | -------- | --------- | -------------------------------------------------------------------------------------------------------------------- | | version | Alphanum | Yes | Call API version | | id\_type\_rapport | Integer | Yes | Report type identifier | | 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 | Yes | Attribution models identifier | | kpis | Alphanum | Yes | KPIs identifier’s list | | segment | Alphanum | Yes | Identifier of the segment that will be used to recover data | | breakdown | String | No | Desired breakdown of aggregated data (none, day, week, month) – “none” is selected by default, nothing will be split | | format | String | No | Response format (XML or JSON) – JSON is selected 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 | | 500 | Internal Server Error | Internal server erros | **Response Format**\ The response is in a JSON or XML format. | FIELD | TYPE | IS ALWAYS PRESENT? | DESCRIPTION | | ---------------- | -------- | ------------------ | ----------------------------------------------------------- | | site | Integer | Yes | Site identifier | | idReport | Integer | Yes | Custom report identifier | | dateStart | Date | Yes | Data recovery start date (YYYY-MM-DD format) | | dateEnd | Date | Yes | Data recovery end date (YYYY-MM-DD format) | | attrib | Alphanum | Yes | Attribution models list identifier | | kpis | Alphanum | Yes | KPIs list identifier | | segment | Integer | Yes | Identifier of the segment that will be used to recover data | | breakdown | String | No | Desired breakdown for aggregated data | | datas | Array | Yes | Table containing data | | datas/date | String | No | Time and date of data according to selected breakdown | | datas/level1 | String | Yes | Level 1 – Channel (in general) | | datas/level2 | String | No | Level 2 – Source (in general) | | datas/level3 | String | No | Level 3 | | datas/kpis | Array | Yes | Table containing the KPIs | | datas/kpis/id | Integer | Yes | KPIs technical identifier | | datas/kpis/label | String | Yes | KPI Label | | datas/kpis/value | Numeric | Yes | KPI Value | **Response example in JSON and XML formats:** ``` { "site": 26, "idReport": 0, "dateStart": "2016-01-01", "dateEnd": "2016-01-30", "attrib": "1,3,4", "kpis": "1,3,6,9", "segment": 2770, "breakdown": "day", "datas": [{ "date": "2016-01-01", "level1": "SEO", "level2": "google", "kpis": [{ "id": "1", "label": "Impressions", "value": "12" }, { "id": "3", "label": "Clicks", "value": "42" }, { "id": "6", "label": "Unique Clicks (by channel)", "value": "2" }, { "id": "9", "label": "Page views", "value": "1" }] }, { "date": "2016-01-02", "level1": "SEO", "level2": "google", "kpis": [{ "id": "1", "label": "Impressions", "value": "12" }, { "id": "3", "label": "Clicks", "value": "42" }, { "id": "6", "label": "Unique Clicks (by channel)", "value": "2" }, { "id": "9", "label": "Page views", "value": "1" }] }] } XML ``` ``` 1,3,4 day 2016-01-30 2016-01-01 1,3,6,9 2770 26 0 SEO google 2016-01-01 1 12 3 42 6 2 9 1 2016-01-02 SEO google 1 12 3 42 6 2 9 1 ``` ## 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.