Get Analytics

This route allows you to view the analytics for a dataset using a structured query.

POST /api/analytics

Get Analytics

cURL

curl --request POST \
  --url https://api.trieve.ai/api/analytics \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "columns": [
    {
      "name": "<string>",
      "alias": "<string>",
      "distinct": true
    }
  ],
  "table": "search_queries",
  "cte_query": {
    "alias": "<string>",
    "query": {
      "columns": [
        {
          "name": "<string>",
          "alias": "<string>",
          "distinct": true
        }
      ],
      "table": "search_queries",
      "expressions": [
        {
          "expression": {
            "name": "<string>",
            "type": "column"
          },
          "alias": "<string>"
        }
      ],
      "filter_conditions": [
        {
          "column": "<string>",
          "value": "<string>",
          "and_filter": "<array>",
          "or_filter": "<array>"
        }
      ],
      "group_by": {
        "columns": [
          "<string>"
        ],
        "having": {
          "column": "<string>",
          "type": "aggregate",
          "value": "<string>"
        }
      },
      "joins": [
        {
          "condition": {
            "left_column": "<string>",
            "right_column": "<string>",
            "type": "column_equals"
          },
          "table": "search_queries"
        }
      ],
      "limit": 1,
      "offset": 1,
      "order_by": {
        "columns": [
          "<string>"
        ]
      }
    }
  },
  "expressions": [
    {
      "expression": {
        "name": "<string>",
        "type": "column"
      },
      "alias": "<string>"
    }
  ],
  "filter_conditions": [
    {
      "column": "<string>",
      "value": "<string>",
      "and_filter": "<array>",
      "or_filter": "<array>"
    }
  ],
  "group_by": {
    "columns": [
      "<string>"
    ],
    "having": {
      "column": "<string>",
      "type": "aggregate",
      "value": "<string>"
    }
  },
  "joins": [
    {
      "condition": {
        "left_column": "<string>",
        "right_column": "<string>",
        "type": "column_equals"
      },
      "table": "search_queries"
    }
  ],
  "limit": 1,
  "offset": 1,
  "order_by": {
    "columns": [
      "<string>"
    ]
  }
}
'

Authorizations

Authorization · string · header · required

Headers

TR-Dataset · string<uuid> · required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to filter the graph

Represents a complete Analytics query with parameters

columns · object[] · required

Simple columns to select

Show child attributes

table · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string> Option 5 · enum<string> Option 6 · enum<string> Option 7 · enum<string> Option 8 · enum<string> Option 9 · enum<string> Option 10 · object · required

Available options: search_queries

cte_query · object | null

Show child attributes

expressions · object[] | null

Complex expressions to select

Show child attributes

filter_conditions · object[] | null

WHERE clause conditions

Show child attributes

group_by · object | null

Represents a GROUP BY clause

Show child attributes

joins · object[] | null

Tables to join with

Show child attributes

limit · integer<int32> | null

LIMIT clause

Required range: x >= 0

offset · integer<int32> | null

OFFSET clause

Required range: x >= 0

order_by · object | null

Show child attributes

Response

200 - application/json

The analytics for the dataset