Historical Data Access

Executes a saved historic report and returns the results as structured data.

This endpoint is useful for pulling time-bounded call activity into external systems, generating custom exports, or feeding downstream reporting pipelines.

The report to execute is identified by its report_id, which corresponds to a report configured within the CCaaS platform.

The request body defines the output format and any report-specific parameters such as the time window or agent filter.

Endpoint

POST /rest/api/v1/historic-data/{report_id}

Path Parameters

Parameter	Type	Required	Description
`report_id`	string	Yes	The unique identifier of the report to execute

Headers

Header	Value	Required	Description
`Content-Type`	application/json	Yes	Response returned as JSON
`Authorization`	Bearer	Yes	The Service User API bearer token
`Host`	`<hostname>.xima.cloud`	Yes	The `FQDN`

Request Body

Field	Type	Required	Description
`format`	string	Yes	Output format for the report; accepted values: `JSON`, `CSV`, `HTML`, `XLS`, `PDF`
`parameters`	array	Yes	List of report parameter objects; contents vary by report type

Parameter Object

Each object in the parameters array contains a name and a value.

Report Timeframe

Field	Type	Description
`name`	string	Must be `"Report Timeframe"`
`value.type`	string	Must be `"REPORT_TIMEFRAME"`
`value.formatted`	string	Human-readable label for the timeframe
`value.start`	string (ISO 8601)	Start of the reporting window; including timezone offset
`value.end`	string (ISO 8601)	End of the reporting window; including timezone offset

Request

POST /rest/api/v1/historic-data/{report_id} HTTP/1.1
Host: <hostname>.xima.cloud
Content-Type: application/json
Authorization: Bearer <api_bearer_token>

{
    "format": "JSON",
    "parameters": [
        {
            "name": "Report Timeframe",
            "value": {
                "type": "REPORT_TIMEFRAME",
                "formatted": "Tuesday, June 2, 2026 12:00:00 AM - Tuesday, June 2, 2026 11:59:59 PM",
                "start": "2026-06-02T00:00:00-06:00",
                "end": "2026-06-03T00:00:00-06:00"
            }
        },
        {
            "name": "Rows (Agent)",
            "value": {
                "type": "PBX_USERS",
                "pbxUsers": [
                    {
                        "key": "Agent_001(999)"
                    }
                ]
            }
        }
    ]
}

curl -L -X POST 'https://<hostname>.xima.cloud/rest/api/v1/historic-data/{report_id}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <api_bearer_token>' \
-d '{
    "format": "JSON",
    "parameters": [
        {
            "name": "Report Timeframe",
            "value": {
                "type": "REPORT_TIMEFRAME",
                "formatted": "Tuesday, June 2, 2026 12:00:00 AM - Tuesday, June 2, 2026 11:59:59 PM",
                "start": "2026-06-02T00:00:00-06:00",
                "end": "2026-06-03T00:00:00-06:00"
            }
        },
        {
            "name": "Rows (Agent)",
            "value": {
                "type": "PBX_USERS",
                "pbxUsers": [
                    {
                        "key": "Agent_001(999)"
                    }
                ]
            }
        }
    ]
}'

Response

Returns a JSON object containing the report results. The structure of the response varies based on the report type and the format specified in the request body.

Updated about 6 hours ago