Get a signal summary export

GET

https://api.agentpaid.io/api/v2/signals/summary/batch/:id

GET

/api/v2/signals/summary/batch/:id

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.signals.getSignalSummaryExport({
        id: "sse_5pZa1Kd8Nqx",
    });
}
main();

{
  "id": "sse_5pZa1Kd8Nqx",
  "status": "pending",
  "spec": {
    "name": "string",
    "signalNames": [
      {
        "name": "string",
        "group": "workflow_run",
        "slug": "runs"
      }
    ],
    "measures": [
      {
        "fn": "count",
        "path": "steps",
        "slug": "string"
      }
    ],
    "interval": "month",
    "dimensions": [
      {
        "kind": "presence",
        "path": "steps",
        "appliesTo": [
          "string"
        ],
        "values": {
          "true": {
            "group": "string",
            "slug": "string"
          },
          "false": {
            "group": "string",
            "slug": "string"
          }
        }
      }
    ],
    "columnNameTemplate": "{dim1}_{signal}_{dim2}"
  },
  "columns": [
    {
      "name": "ticket_runs_1_step",
      "signalGroup": "string",
      "dimensionGroup": "string"
    }
  ],
  "format": "json",
  "from": "2025-09-01",
  "to": "2026-09-01",
  "rowCount": 1,
  "downloadUrl": "string",
  "expiresAt": "2024-01-15T09:30:00Z",
  "error": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "completedAt": "2024-01-15T09:30:00Z"
}

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.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200

idstring

statusenum

Allowed values:

specobject

The shape this export ran, stored here so the file stays explainable. Pass this export's id as copyFrom to reproduce its columns.

columnslist of objects

Columns in the file, in order.

formatenum

Format this export's file was written in.

Allowed values:

fromstring

tostring

rowCountinteger or null

downloadUrlstring or null

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

expiresAtdatetime or null

When the stored file stops being downloadable.

errorstring or null

Why the export failed, or null.

createdAtdatetime

completedAtdatetime or null

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error