signals

Start a signal summary export

Produces a usage summary file: one row per customer per month, with columns broken down by the signal payload fields you name. Choose format to get JSON or a wide CSV; JSON is the default. The export runs in the background, so this returns immediately with a pending export and the file appears on it once it succeeds. Give spec to describe the columns, or copyFrom with an earlier export's id to reuse that export's columns over a new window. The spec is stored on the export, so an old file can always be explained by the export that produced it. Signals are bucketed by month in UTC on their effective timestamp, the same basis billing uses, so the totals reconcile with invoices. One export runs per organization at a time.

post/signals/summary/batch/

Request

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

Request body

copyFromstring

Reuse the shape of an earlier export, so a monthly run produces the same columns without restating them. Give this or spec, not both.

fromstring required

Start of the window, inclusive, snapped down to a period start. Cannot be earlier than 2025-09-01.

tostring required

End of the window, exclusive, snapped down to a period start.

customerIdsstring[]

Restrict the file to these customers. Accepts Paid IDs, UUIDs, or your external IDs. Omit for every customer.

format'json' | 'csv'

Format of the produced file. json gives the columns and one object per customer per month; csv gives the wide spreadsheet with three header rows.

Response

202

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.