---
title: "Get traffic analytics."
method: GET
path: "/api/v1/projects/{projectId}/reports/traffic"
tags: ["Reports & Analytics"]
---

# Get traffic analytics.

`GET /api/v1/projects/{projectId}/reports/traffic`

## Request

- Base URL: `https://app.customgpt.ai`
- URL: `https://app.customgpt.ai/api/v1/projects/{projectId}/reports/traffic`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/poll-the-people/apis/customgpt-ai/docs/api/v1/projects/:projectId/reports/traffic/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `projectId` integer, required

## Query parameters

- `filters` string[], required

## Response `200`

Get the traffic metrics for an agent

- object
  - `status` 'error' | 'success': The status of the response
  - `data` ProjectAnalyticsTraffic
    - `sources` object[]: Breakdown of conversation traffic by origin channel. Each entry shows a source and its conversation count.
      - `request_source` 'web' | 'ama' | 'iframe' | 'api' | 'api-openai' | 'sdk' | 'slack' | 'embed' | 'livechat' | 'sge' | 'ai-assistant' | 'instant-viewer' | 'mcp' | 'ama-try' | 'onboarding' | 'schedule': The origin channel of the traffic.
      - `request_source_number` integer: The number of conversations from this source in the selected time period.

## Other responses

- `400`: Bad Argument
- `401`: API Token is either missing or invalid
- `404`: Agent not found
- `429`: Too many requests. You have exceeded your API rate limit.
- `500`: Internal Server Error

## Changes

- **2026-11-03** `77aab4354382`: 7 warning, 1 info
  - added the new `422.00` enum value to the `data/code` response property for the response status `400`
  - added the new `422.00` enum value to the `data/code` response property for the response status `401`
  - added the new `422.00` enum value to the `data/code` response property for the response status `404`
  - added the new `422.00` enum value to the `data/code` response property for the response status `500`
  - …4 more
- **2026-07-17** `b80e6dfcf78d`: 1 info
  - endpoint added
- **2023-06-02** `1842d7fd0430`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/poll-the-people/apis/customgpt-ai/changes/api/v1/projects/:projectId/reports/traffic/get.md)

---

[API](https://skmtc.dev/poll-the-people/apis/customgpt-ai.md) - [All operations](https://skmtc.dev/poll-the-people/apis/customgpt-ai/llms.txt) - [OpenAPI document](https://skmtc.dev/poll-the-people/apis/customgpt-ai/revisions/77aab4354382?raw)