POST
/
api
/
analytics
Get Analytics
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": [
    {
      "aggregation": "SUM",
      "alias": "<string>",
      "distinct": true,
      "name": "<string>"
    }
  ],
  "cte_query": {
    "alias": "<string>",
    "query": {
      "columns": [
        {
          "aggregation": "SUM",
          "alias": "<string>",
          "distinct": true,
          "name": "<string>"
        }
      ],
      "expressions": [
        {
          "alias": "<string>",
          "expression": {
            "name": "<string>",
            "type": "column"
          }
        }
      ],
      "filter_conditions": [
        {
          "and_filter": [
            {}
          ],
          "column": "<string>",
          "operator": "=",
          "or_filter": [
            {}
          ],
          "value": "<string>"
        }
      ],
      "group_by": {
        "columns": [
          "<string>"
        ],
        "having": {
          "column": "<string>",
          "function": "SUM",
          "operator": "=",
          "type": "aggregate",
          "value": "<string>"
        }
      },
      "joins": [
        {
          "condition": {
            "left_column": "<string>",
            "right_column": "<string>",
            "type": "column_equals"
          },
          "join_type": "inner",
          "table": "search_queries"
        }
      ],
      "limit": 1,
      "offset": 1,
      "order_by": {
        "columns": [
          "<string>"
        ],
        "direction": "asc"
      },
      "table": "search_queries"
    }
  },
  "expressions": [
    {
      "alias": "<string>",
      "expression": {
        "name": "<string>",
        "type": "column"
      }
    }
  ],
  "filter_conditions": [
    {
      "and_filter": [
        {}
      ],
      "column": "<string>",
      "operator": "=",
      "or_filter": [
        {}
      ],
      "value": "<string>"
    }
  ],
  "group_by": {
    "columns": [
      "<string>"
    ],
    "having": {
      "column": "<string>",
      "function": "SUM",
      "operator": "=",
      "type": "aggregate",
      "value": "<string>"
    }
  },
  "joins": [
    {
      "condition": {
        "left_column": "<string>",
        "right_column": "<string>",
        "type": "column_equals"
      },
      "join_type": "inner",
      "table": "search_queries"
    }
  ],
  "limit": 1,
  "offset": 1,
  "order_by": {
    "columns": [
      "<string>"
    ],
    "direction": "asc"
  },
  "table": "search_queries"
}'
"<any>"

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string
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

Response

200 - application/json

The analytics for the dataset

The response is of type any.