Reports

Run saved reports.

POST Run a saved report

#Run a saved report

POST/api/v1/reports/{id}/run

Operation run_report · needs scope reports:read

Runs the saved definition now. A key acting as a member opens that member's own, shared and workspace reports; other keys open workspace-visible reports. Totals include only records the key may see.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the saved report.

bash

curl -X POST https://synconone.com/api/v1/reports/pr_1a2b3c4d5e6f7a8b/run \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "name": "Emily Carter",
    "result": {
      "type": "string",
      "columns": [
        {}
      ],
      "rows": [
        {}
      ],
      "totals": [
        1
      ],
      "truncated": true,
      "currency": "string",
      "empty": {
        "reason": "string",
        "message": "string"
      },
      "notes": [
        "string"
      ],
      "generatedAt": "string"
    }
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.