Skip to main content
POST
/
api
/
v1
/
reports
Create a new report generation job
curl --request POST \
  --url https://prod.featherhq.com/api/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "filters": {}
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "filters": {
    "callEndedReasons": [],
    "startCallStartedAt": "2023-11-07T05:31:56Z",
    "endCallStartedAt": "2023-11-07T05:31:56Z"
  },
  "fileKey": "<string>",
  "rowCount": 123,
  "errorMessage": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "completedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.featherhq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
filters
object

Response

Report generation job created successfully

​
id
string
required
​
organizationId
string
required
​
status
enum<string>
required
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
type
enum<string>
required
Available options:
AGENT_CALLS
​
filters
object
required
​
fileKey
string | null
required
​
rowCount
number | null
required
​
errorMessage
string | null
required
​
createdAt
string
required
​
updatedAt
string
required
​
completedAt
string | null
required