Analytics
GET Analytics#
Gets distribution analytics.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/analytics |
| Headers | Authorization |
| Parameters | distributionId, projectId, version, from, to , intervalType, TermCount |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| analytics | Yes | string | Directs you to analytics |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| from | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write from which date you want to get analytics data |
| to | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write to which date you want to get analytics data |
| intervalType | No | integer($int32) | 2 | Shows data hourly monthly daily depends on what you have selected |
| TermCount | No | integer($int32) | 2 | Choose how many user's devices you want to see. It returns all the devices of users |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "averageServeTime": 0, "totalBytes": 0, "hits": 0, "misses": 0, "topReferers": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] }, "aggregatesPerInterval": [ { "time": "2021-04-26T10:15:32.736Z", "bytes": 0, "numberOfRequests": 0 } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| averageServeTime | integer($int32) | 0 | Returns the average of serve time on CDN |
| totalBytes | integer($int32) | 0 | Returns the total bytes |
| hits | integer($int32) | 0 | Returns cache hits |
| misses | integer($int32) | 0 | Returns cache misses |
| topReferers | array [object] | Returns an object of pages that sended requests | |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| aggregatesPerInterval | array [object] | Returns the aggregates per interval on which you chose on CDN | |
| time | date-time | "2021-04-26T10:15:32.736Z" | Returns time of the interval that used CDN |
| bytes | integer($int32) | 0 | Returns spent bytes of used CDN |
| numberOfRequests | integer($int32) | 0 | Returns the number of requests of CDN |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Geographical Analytics#
Gets distribution gjeographical analytics.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/analytics/geo |
| Headers | Authorization |
| Parameters | distributionId, projectId, version, from, to , intervalType, TermCount |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| analytics | Yes | string | Directs you to analytics | |
| geo | Yes | string | Directs you to geographical analytics |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| from | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write from which date you want to get analytics data |
| to | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write to which date you want to get analytics data |
| intervalType | No | integer($int32) | 2 | Shows data hourly monthly daily depends on what you have selected |
| TermCount | No | integer($int32) | 2 | Choose how many user's devices you want to see. It returns all the devices of users |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "continents": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] }, "countries": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| continents | array [object] | Returns all continents | |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| countries | array [object] | 0 | Returns all the countries |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Path Statistics#
Gets distribution path statistics.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/analytics/path |
| Headers | Authorization |
| Parameters | distributionId, projectId, version, from, to , intervalType, TermCount |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| analytics | Yes | string | Directs you to analytics | |
| path | Yes | string | Directs you to path statistics |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| from | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write from which date you want to get analytics data |
| to | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write to which date you want to get analytics data |
| intervalType | No | integer($int32) | 2 | Shows data hourly monthly daily depends on what you have selected |
| TermCount | No | integer($int32) | 2 | Choose how many user's devices you want to see. It returns all the devices of users |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "continents": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] }, "countries": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| continents | array [object] | Returns all continents | |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| countries | array [object] | 0 | Returns all the countries |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Device Statistics#
Gets distribution device statistics.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/analytics/device |
| Headers | Authorization |
| Parameters | distributionId, projectId, version, from, to , intervalType, TermCount |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| analytics | Yes | string | Directs you to analytics | |
| path | Yes | string | Directs you to path statistics |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| from | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write from which date you want to get analytics data |
| to | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write to which date you want to get analytics data |
| intervalType | No | integer($int32) | 2 | Shows data hourly monthly daily depends on what you have selected |
| TermCount | No | integer($int32) | 2 | Choose how many user's devices you want to see. It returns all the devices of users |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "continents": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] }, "countries": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| continents | array [object] | Returns all continents | |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| countries | array [object] | 0 | Returns all the countries |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET Referer Statistics#
Gets distribution referer statistics.
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/analytics/referers |
| Headers | Authorization |
| Parameters | distributionId, projectId, version, from, to , intervalType, TermCount |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| analytics | Yes | string | Directs you to analytics | |
| path | Yes | string | Directs you to path statistics |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| from | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write from which date you want to get analytics data |
| to | No | string($date-time) | "2021-04-26T10:15:32.736Z" | Write to which date you want to get analytics data |
| intervalType | No | integer($int32) | 2 | Shows data hourly monthly daily depends on what you have selected |
| TermCount | No | integer($int32) | 2 | Choose how many user's devices you want to see. It returns all the devices of users |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "continents": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] }, "countries": { "otherCount": 0, "buckets": [ { "name": "string", "count": 0 } ] } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| continents | array [object] | Returns all continents | |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| countries | array [object] | 0 | Returns all the countries |
| otherCount | integer($int32) | 0 | Returns all the other pages and their number of refered times |
| buckets | array [object] | Returns by default 7 buckets of those pages | |
| name | string | "string" | Returns the bucket name |
| count | integer($int32) | 0 | Returns the number of refered times |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found