GET Traffic Report (deprecated)

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:
1
{
2
"site": 26,
3
"idReport": 0,
4
"dateStart": "2016-01-01",
5
"dateEnd": "2016-01-30",
6
"attrib": "1,3,4",
7
"kpis": "1,3,6,9",
8
"segment": 2770,
9
"breakdown": "day",
10
"datas": [{
11
"date": "2016-01-01",
12
"level1": "SEO",
13
"level2": "google",
14
"kpis": [{
15
"id": "1",
16
"label": "Impressions",
17
"value": "12"
18
}, {
19
"id": "3",
20
"label": "Clicks",
21
"value": "42"
22
}, {
23
"id": "6",
24
"label": "Unique Clicks (by channel)",
25
"value": "2"
26
}, {
27
"id": "9",
28
"label": "Page views",
29
"value": "1"
30
}]
31
}, {
32
"date": "2016-01-02",
33
"level1": "SEO",
34
"level2": "google",
35
"kpis": [{
36
"id": "1",
37
"label": "Impressions",
38
"value": "12"
39
}, {
40
"id": "3",
41
"label": "Clicks",
42
"value": "42"
43
}, {
44
"id": "6",
45
"label": "Unique Clicks (by channel)",
46
"value": "2"
47
}, {
48
"id": "9",
49
"label": "Page views",
50
"value": "1"
51
}]
52
}]
53
}
54
55
XML
56
Copied!
1
<?xml version="1.0" encoding="UTF-8"?>
2
<root>
3
<attrib>1,3,4</attrib>
4
<breakdown>day</breakdown>
5
<dateEnd>2016-01-30</dateEnd>
6
<dateStart>2016-01-01</dateStart>
7
<kpis>1,3,6,9</kpis>
8
<segment>2770</segment>
9
<site>26</site>
10
<idReport>0</idReport>
11
<datas>
12
<data>
13
<level1>SEO</level1>
14
<level2>google</level2>
15
<date>2016-01-01</date>
16
<kpis>
17
<kpi>
18
<id>1</id>
19
<label>Impressions</label>
20
<value>12</value>
21
</kpi>
22
<kpi>
23
<id>3</id>
24
<label>Clicks</label>
25
<value>42</value>
26
</kpi>
27
<kpi>
28
<id>6</id>
29
<label>Unique Clicks (by channel)</label>
30
<value>2</value>
31
</kpi>
32
<kpi>
33
<id>9</id>
34
<label>Page views</label>
35
<value>1</value>
36
</kpi>
37
</kpis>
38
</data>
39
<data>
40
<date>2016-01-02</date>
41
<level1>SEO</level1>
42
<level2>google</level2>
43
<kpis>
44
<kpi>
45
<id>1</id>
46
<label>Impressions</label>
47
<value>12</value>
48
</kpi>
49
<kpi>
50
<id>3</id>
51
<label>Clicks</label>
52
<value>42</value>
53
</kpi>
54
<kpi>
55
<id>6</id>
56
<label>Unique Clicks (by channel)</label>
57
<value>2</value>
58
</kpi>
59
<kpi>
60
<id>9</id>
61
<label>Page views</label>
62
<value>1</value>
63
</kpi>
64
</kpis>
65
</data>
66
</datas>
67
</root>
Copied!
Export as PDF
Copy link