POpoll-the-people
Reports & Analytics

Get traffic analytics.

Changed on

Returns a breakdown of conversation volume by deployment channel (e.g. web widget, API, Slack, WhatsApp) over the requested time window. Use the filters query parameter to scope the report.

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

Request

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
      }
    ]
  }
}

Changes

  • 77aab4354382Revision changes
    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new 422.00 enum value to the / response property for the response status

    • warning

      added the new ama-try enum value to the /// response property for the response status

    • warning

      added the new onboarding enum value to the /// response property for the response status

    • warning

      added the new schedule enum value to the /// response property for the response status

    • info

      added the non-success response with the status

  • b80e6dfcf78dRevision changes
    • info

      endpoint added