Get Component Analytics

This route allows you to view the component analytics for a dataset.

POST /api/analytics/events/component

Try it

Get Component Analytics

cURL

curl --request POST \
  --url https://api.trieve.ai/api/analytics/events/component \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "type": "total_unique_users",
  "filter": {
    "component_name": "<string>",
    "date_range": {
      "gt": "2021-01-01 00:00:00.000",
      "gte": "2021-01-01 00:00:00.000",
      "lt": "2021-01-01 00:00:00.000",
      "lte": "2021-01-01 00:00:00.000"
    }
  },
  "granularity": "minute"
}'

200

{
  "points": [
    {
      "point": 123,
      "time_stamp": "<string>"
    }
  ],
  "total_unique_users": 1
}

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

TotalUniqueUsers

type · enum<string> · required

Available options: total_unique_users

filter · object

Show child attributes

filter. component_name · string | null

filter. date_range · object

DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone.

Show child attributes

filter.date_range. gt · string | null

filter.date_range. gte · string | null

filter.date_range. lt · string | null

filter.date_range. lte · string | null

Example:

{
  "gt": "2021-01-01 00:00:00.000",
  "gte": "2021-01-01 00:00:00.000",
  "lt": "2021-01-01 00:00:00.000",
  "lte": "2021-01-01 00:00:00.000"
}

granularity · enum<string>

Available options: minute, second, hour, day, month

Response

200

application/json

The component analytics for the dataset

Option 1

points · object[] · required

Show child attributes

points. point · integer<int64> · required

points. time_stamp · string · required

total_unique_users · integer<int64> · required

Required range: x >= 0