This web service responds with detailed information about the sources.
Method | Endpoint |
---|---|
POST |
/analytics/api/v1/traffic/sources/detail |
Request example
{
"startDate": "2023-10-01",
"endDate": "2023-12-01",
"filters": {
"pageId": [
"45d2564c-c877-4c8b-84cb-a9c3f7f8f97d",
"ft/home",
"ft/search",
"ft/reader",
"ft/viewer"
],
"language": "en-US",
"authenticated": true,
"sourceTypes": [
"direct",
"organic",
"referral",
"social"
]
}
}
Field | Type | Required? | Description |
---|---|---|---|
startDate |
String | Yes | Inclusive start date of the period. The start date must be in the past year. |
endDate |
String | Yes | Exclusive end date of the period. The end date must be later than the start date. |
filters |
Object | No | Field to specify which events to retrieve. |
pageId |
Array | No | Filter on page IDs. |
language |
String | No | Filter on the UI Locale (for example, en-US or fr-FR ). |
authenticated |
Boolean | No | Field to define users' status. If undefined, the web service returns page views for both authenticated and unauthenticated users. If set to true , the web service returns only navigation information for authenticated users. if set to false , the web service returns only navigation information for unauthenticated users. |
sourceTypes |
Array | No | Filter on the source type. Possible values are direct , organic , referral , and social . |
Response body
The following lines show an example of a JSON response body:
{
"startDate": "2023-08-01",
"endDate": "2023-11-01",
"results": [
{
"name": "direct",
"value": 11861,
"children": []
},
{
"name": "organic",
"children": [
{
"name": "Google",
"value": 796,
"children": []
},
{
"name": "Yandex",
"value": 76,
"children": []
},
{
"name": "Bing",
"value": 5,
"children": []
},
{
"name": "Brave",
"value": 1,
"children": []
},
{
"name": "Ecosia",
"value": 1,
"children": []
}
]
},
{
"name": "referral",
"children": [
{
"name": "https://jira.antidot.net/",
"value": 566
},
{
"name": "https://www.fluidtopics.com/",
"value": 283
},
{
"name": "https://statics.teams.cdn.office.net/",
"value": 279
},
{
"name": "https://components.fluidtopics.com/",
"value": 146
},
{
"name": "https://teams.microsoft.com/",
"value": 16
},
{
"name": "Other referrals",
"value": 126
}
]
},
{
"name": "social",
"children": [
{
"name": "LinkedIn",
"value": 5,
"children": []
}
]
}
]
}
Field | Type | Description |
---|---|---|
startDate |
String | Inclusive start date of the total period as defined in the request. |
endDate |
String | Exclusive end date of the total period as defined in the request. |
name |
String | A source type. |
value |
Number | The number of visits from this source. |
children |
Array | Specific sources in a source type. |
name |
String | The name or URL of a specific source in a parent source type. |
Return code | Description |
---|---|
200 OK |
Returns data in JSON format. |