Sign in
dashboards

Query one gateway-paginated table widget page.

Changed on
get/api/agent/{agentName}/dashboard/{dashboardName}/widget/{widgetName}/rows

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/agent/{agentName}/dashboard/{dashboardName}/widget/{widgetName}/rows
  • Auth: HTTP bearer

Path parameters

agentNamestring required

Agent name.

dashboardNamestring required

Dashboard name.

widgetNamestring required

Widget name.

Query parameters

event_time_afterstring date-time

Inclusive lower bound for event time.

event_time_beforestring date-time

Inclusive upper bound for event time.

page_tokenstring

Opaque pagination token from a previous response.

sortstring[]

Headers

X-AgentZ-Workspace-IDstring

Stable Workspace ID selecting Workspace scope. Omit for Organisation scope.

Response

One 25-row table page.

status'ok' | 'empty' | 'invalid_data' | 'limit_exceeded' | 'query_failed' required
next_page_tokenstring required

Changes