Skip to main content
GET
List all data points on an event

Authorizations

Authorization
string
header
required

Path Parameters

project_id
string
required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

event_id
string
required

The event's friendly ID (e.g. evt_aBcD1234eFgH5678).

Query Parameters

page
integer<int32>
default:1

The page to return, starting at 1. A value below 1 or a non-numeric value returns 400.

Required range: x >= 1
page_size
integer<int32>
default:20

Rows per page, from 1 to 200. A value below 1 counts as 1 and a value above 200 as 200; a non-numeric value uses the default.

Required range: 1 <= x <= 200
sort
string

Sortable fields: id, start_time, end_time, created_at, updated_at, status. Defaults to start_time ascending, with ties broken by id ascending.

Example:

"status,-created_at"

fields
string

Comma-separated fields to return in each row: id, slug, data_point_type, value, unit, status. Other names are ignored, and when none is valid every field is returned.

filter[status][eq]
enum<string>
Available options:
complete,
incomplete,
pending_review,
anomalous
filter[slug][eq]
string

Only data points whose data point type has this slug, the same slug shown on each data point. Only eq is supported; any other comparator returns 400. An unknown slug returns an empty page.

filter[value][eq]
string

Filter by value. Only eq is supported. The request must narrow to a single data point type with filter[slug][eq], and returns 400 without one, or when the slug matches no type on this event's event type. The value is read by that type's value_type: a number for number, true or false for boolean, and one of the type's options for enumeration. A value that does not read that way returns 400, and so does a string type, which cannot be filtered by value. Data points with no value never match.

filter[start_time][geq]
string<date-time>

Data points starting on or after this time.

filter[start_time][leq]
string<date-time>

Data points starting on or before this time.

filter[end_time][geq]
string<date-time>

Data points ending on or after this time.

filter[end_time][leq]
string<date-time>

Data points ending on or before this time.

response_mode
enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. summary_with_export returns the summary and queues an export of every matching record.

Available options:
default,
summary,
summary_with_export
export_format
enum<string>
default:csv

The export's file format. Applies only with response_mode=summary_with_export. Events, data points and assets also export to xlsx.

Available options:
csv,
json,
xlsx

Response

Paginated list. With response_mode=summary, a count and up to 10 samples instead; with summary_with_export, the summary plus a queued export.

data
object[]
required
info
object
required

Where this page sits in the full result, and the sort, filters and fields the request applied.