Skip to main content
GET
/
api
/
v1
/
reports
List generated reports
curl --request GET \
  --url https://prod.featherhq.com/api/v1/reports \
  --header 'X-API-Key: <api-key>'
{
  "reports": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "status": "PENDING",
      "type": "AGENT_CALLS",
      "filters": {
        "callEndedReasons": [
          "COULD_NOT_CONNECT"
        ],
        "startCallStartedAt": "2023-11-07T05:31:56Z",
        "endCallStartedAt": "2023-11-07T05:31:56Z"
      },
      "fileKey": "<string>",
      "rowCount": 123,
      "errorMessage": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "completedAt": "<string>"
    }
  ],
  "pagination": {
    "limit": 10,
    "nextCursor": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
string

Number of items per page (default: 10, max: 100)

cursor
string

Cursor for pagination (ID of the last item in previous page)

status
enum<string>

Filter by report status

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED

Response

Reports retrieved successfully

reports
object[]
required
pagination
object
required