Reports API

This endpoint lets you retrieve past report runs filtered by report type.

Resulting file

The generated report will have a temporary URL that expires after one hour. Check the expiresAt field to know when the URL will no longer be valid.

get

Authorizations

Path parameters

businessIdanyRequired

Business identifier

Query parameters

typeanyOptional

Report type

Responses

200

A successful response.

application/json

default

An unexpected error response.

application/json

get

HTTPcURLJavaScriptPython

GET /v1/businesses/{businessId}/reporting/reports HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "c80716a5-62c5-4ba5-b99d-5c2a6fd39317",
      "name": "Daily campaign report",
      "lastRun": {
        "id": "c80716a5-62c5-4ba5-b99d-5c2a6fd39317",
        "status": "completed",
        "result": {
          "url": "https://reports.connectly.ai/abcdef"
        }
      },
      "type": "campaign.daily.v1"
    }
  ]
}