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

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <attrib>1,3,4</attrib>
   <breakdown>day</breakdown>
   <dateEnd>2016-01-30</dateEnd>
   <dateStart>2016-01-01</dateStart>
   <kpis>1,3,6,9</kpis>
   <segment>2770</segment>
   <site>26</site>
   <idReport>0</idReport>
   <datas>
      <data>
	 <level1>SEO</level1>
         <level2>google</level2>
         <date>2016-01-01</date>
         <kpis>
            <kpi>
               <id>1</id>
               <label>Impressions</label>
               <value>12</value>
            </kpi>
            <kpi>
               <id>3</id>
               <label>Clicks</label>
               <value>42</value>
            </kpi>
            <kpi>
               <id>6</id>
               <label>Unique Clicks (by channel)</label>
               <value>2</value>
            </kpi>
            <kpi>
               <id>9</id>
               <label>Page views</label>
               <value>1</value>
            </kpi>
         </kpis>
      </data>
      <data>
         <date>2016-01-02</date>
	 <level1>SEO</level1>
         <level2>google</level2>
         <kpis>
            <kpi>
               <id>1</id>
               <label>Impressions</label>
               <value>12</value>
            </kpi>
            <kpi>
               <id>3</id>
               <label>Clicks</label>
               <value>42</value>
            </kpi>
            <kpi>
               <id>6</id>
               <label>Unique Clicks (by channel)</label>
               <value>2</value>
            </kpi>
            <kpi>
               <id>9</id>
               <label>Page views</label>
               <value>1</value>
            </kpi>
         </kpis>
      </data>
   </datas>
</root>

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.