This web service responds with the number of user sessions logged during a selected period.
| Method | Endpoint |
|---|---|
POST |
/analytics/api/v2/traffic/sessions |
Request example
The following lines show an example of a JSON request body:
{
"startDate": "2023-04-01",
"endDate": "2023-06-01",
"groupByPeriod": "month"
}
| Field | Type | Required? | Description |
|---|---|---|---|
startDate |
String | Yes | The inclusive start date of the period. |
endDate |
String | Yes | The exclusive end date of the period. |
groupByPeriod |
String | Yes | The period by which to group the sessions. Valid values are month and day. |
Response body
The following lines show an example of a JSON response body:
{
"startDate": "2023-04-01",
"endDate": "2023-06-01",
"results": [
{
"periodStartDate": "2023-04-01",
"periodEndDate": "2023-05-01",
"sessionCount": 123
},
{
"periodStartDate": "2023-05-01",
"periodEndDate": "2023-06-01",
"sessionCount": 456
}
]
}
| Field | Type | Description |
|---|---|---|
startDate |
String | The inclusive start date of the total period as defined in the request body. |
endDate |
String | The exclusive end date of the total period as defined in the request body. |
periodStartDate |
String | The inclusive start date of the period by which results are grouped. |
periodEndDate |
String | The exclusive end date of the period by which results are grouped. |
sessionCount |
Number | The number of sessions during the period by which results are grouped. |
| Return code | Description |
|---|---|
200 OK |
Returns 0 or more results. |