Skip to main content
POST
/
v0
/
reporting
/
datasources
/
{id}
/
columns
curl --request POST \
  --url https://api.avidoai.com/v0/reporting/datasources/{id}/columns \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "intent": "filters"
}
'
{
  "data": {
    "datasource": "eval",
    "intent": "filters",
    "columns": [
      {
        "id": "id",
        "name": "Evaluation ID",
        "type": "string"
      },
      {
        "id": "createdAt",
        "name": "Created Date",
        "type": "date"
      },
      {
        "id": "status",
        "name": "Status",
        "type": "string"
      },
      {
        "id": "score",
        "name": "Score",
        "type": "number"
      },
      {
        "id": "passed",
        "name": "Passed",
        "type": "boolean"
      }
    ]
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
enum<string>
required

Datasource name

Available options:
task,
test,
eval,
topic,
tag
Example:

"task"

Body

application/json

Request for context-aware column retrieval based on query intent

​
intent
enum<string>
required

Intent for which columns are needed

Available options:
filters,
groupBy,
measurements,
orderBy
Example:

"filters"

​
filters
(ReportingQueryStringFilter · object | ReportingQueryNumberFilter · object | ReportingQueryBooleanFilter · object | ReportingQueryDateFilter · object)[]

Current filters applied (used for context when intent is orderBy)

Filter for string columns using eq/neq operators

​
groupBy
(ReportingQueryGroupByBase · object | ReportingQueryGroupByDate · object)[]

Current groupBy clauses (required when intent is orderBy to determine available sort columns)

Group by specification for non-date columns

​
measurements
Measurement · object[]

Current measurements (required when intent is orderBy to include measurement aliases as sortable columns)

Response

Successfully retrieved context-aware columns

Response containing context-aware columns for the specified intent

​
data
object
required