Skip to main content
POST
/
v0
/
reporting
/
query
curl --request POST \
  --url https://api.avidoai.com/v0/reporting/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "query": [
    {
      "type": "datasource",
      "value": "task"
    }
  ]
}
'
{
  "data": {
    "datasource": "task",
    "results": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "orgId": "org_123456",
        "title": "Example Task",
        "type": "STATIC",
        "createdAt": "2024-01-05T12:34:56.789Z"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for querying reporting data

​
query
(ReportingQueryDatasource · object | ReportingQueryFilter · object)[]
required

Array of query items

Minimum array length: 1

A single query item (datasource or filter) for the reporting query endpoint

Response

Successfully queried reporting data

Successful response from reporting query

​
data
object
required