signals

Get a signal summary export

Returns one export with its status and the shape it ran. While it is succeeded and unexpired, each read issues a fresh short-lived download link.

get/signals/summary/batch/{id}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/signals/summary/batch/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

200

idstring required
status'pending' | 'running' | 'succeeded' | 'failed' required
format'json' | 'csv' required

Format this export's file was written in.

fromstring required
tostring required
rowCountinteger nullable required
downloadUrlstring nullable required

Short-lived download link, present only while the export is succeeded and unexpired. A new link is issued each time this export is fetched.

expiresAtstring date-time nullable required

When the stored file stops being downloadable.

errorstring nullable required

Why the export failed, or null.

createdAtstring date-time required
completedAtstring date-time nullable required

Changes

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