Query your analytics
Easily query analytics from your phospho project
This is the main endpoint for querying data from phospho. It can be used add an analytics dashboard in your product, query data for further analysis or export to destinations not yet supported by phospho.
Most of the vizualisations in the phospho dashboard are built using this service.
Using temporal dimensions
If the dimension is month
, week
or day
the data will be grouped by the corresponding time unit from the created_at
field.
The time will be formated in UTC time with the corresponding format: YYYY-MM
for months, YYYY-MM-DD
for days,…
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The metric to be analyzed.
sum
, avg
, nb_messages
, nb_sessions
, tags_count
, avg_success_rate
, avg_session_length
, tags_distribution
The metadata field to be analyzed.
The field to break down the metric by. Can be a metadata field, a time field, event_name, task_position, None, session_length
day
, week
, month
, tagger_name
, task_position
, session_length
This is a model used to filter tasks, sessions or events in different endpoints.
Response
Was this page helpful?