Reports: Get Account reports
gapify_get_account_reportsFetch time-series report data by metric, report type, and date range to analyze account support performance.
Instructions
Get time-series report data for a metric, report type and date range [Reports]
GET /api/v2/accounts/{account_id}/reports
Auth: User API key (header api-access-token).
Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Query param. The Id of specific object in case of agent/inbox/label | |
| type | No | Query param. Type of report One of: `account`, `agent`, `inbox`, `label`, `team` Example: account | |
| since | No | Query param. The timestamp from where report should start. | |
| until | No | Query param. The timestamp from where report should stop. | |
| metric | No | Query param. The type of metric One of: `conversations_count`, `incoming_messages_count`, `outgoing_messages_count`, `avg_first_response_time`, `avg_resolution_time`, `resolutions_count` Example: conversations_count | |
| account_id | Yes | The numeric ID of the account |