v1

latestOpenAPI 3.0.22026-07-174617345.8 KB

Reports & Analytics

Provide summary of various metrics of users interactions with the application.

Provide summary of various metrics of users interactions with the application such as the users number (both named and anonymous), their geographical locations, the browsers they use, and the sources from which they arrived at the application.

get/api/v1/projects/{projectId}/reports/traffic

Path parameters

projectIdinteger required

Example:1

The ID of the agent to get traffic for

Query parameters

filtersstring[] required

Filters to return traffic metrics for.

Response

Get the traffic metrics for an agent

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "sources": [
      {
        "request_source": "web",
        "request_source_number": 20
      }
    ]
  }
}