Events (v1)

List events

Retrieve a list of events. Also available nested under an action as /api/v1/actions/:agent_id/events. A response whose payloads exceed 200MB returns a 422 error.

get/api/v1/agents/{agent_id}/events

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/agents/{agent_id}/events
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

agent_idinteger required

The ID of the action whose events to retrieve

Query parameters

team_idinteger

Filter by the given team. When team_id and story_id are used together, story_id is ignored

story_idinteger

Filter by the given story. When team_id and story_id are used together, story_id is ignored

story_modestring

Set to test to retrieve events from the story's default test story. Only valid with story_id

include_groupsboolean

Include events from groups in the specified story. Only valid with story_id (defaults to false)

since_idinteger

Only retrieve events after this ID

until_idinteger

Only retrieve events until (and including) this ID

sincestring

Only retrieve events created after this time (ISO 8601 timestamp)

untilstring

Only retrieve events until this time (ISO 8601 timestamp)

show_reemitted_events_onlyboolean

Only retrieve events that have been re-emitted (defaults to false)

exclude_previous_event_payloadsboolean

When true, each event's payload contains only its own output, excluding payloads received from upstream events (defaults to false)

per_pageinteger

Number of results per page (defaults to 20, maximum 500)

pageinteger

Page number (defaults to 1)

Response

Successful response

Changes

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