Widgets

Get Widget Data

Answer one saved widget for a window, with a status instead of an exception.

get/api/v1/public/widgets/{widget_id}/data

Request

  • Base URL
    https://app.traceroot.ai
  • URL
    https://app.traceroot.ai/api/v1/public/widgets/{widget_id}/data
  • Auth
    HTTP bearer

Path parameters

widget_idstring required

Query parameters

range'30m' | '1h' | '3h' | '6h' | '1d' | '7d' | '14d' | '30d' | '60d' | '90d' nullable

A preset window ending now, by the site picker's id. Give this or explicit start_time/end_time; neither means the site's 24-hour default.

start_timestring date-time nullable
end_timestring date-time nullable
project_idstring nullable

Target project for the request. Required when authenticating with a user session token (a user credential is only meaningful scoped to a project); for an API key it is optional and, if given, must match the key's project.

Response

Successful Response

columnsstring[] nullable
errorstring nullable
metaobject nullable
status'ok' | 'skipped' | 'error' required
truncatedboolean

Changes

No recorded changes to this operation across all 1 revision of this API.