Skip to content
Docs
Open Backstage
Operation

Create a saved report

POST/reports/saved
Persist a cube query + viz + slicer params as a reusable report.

Headers

Idempotency-KeystringOptional
Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.

Body

name*string
descriptionstring
accountIdstring
▼query*object
measuresstring[]
dimensionsstring[]
▶timeDimensionsobject[]
▶filtersobject[]
segmentsstring[]
orderobject | array[]
limitinteger
offsetinteger
timezonestring
▼paramsobject[]
kind*"timeRange" | "groupBy" | "filter" | "compare"
memberstring
labelstring
allowedstring[]
▼vizobject
type*"table" | "line" | "bar" | "area" | "pie" | "kpi"
xstring
ystring | string[]
seriesstring

Returns

Saved report created

Errors

400
Bad Request - Invalid input
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error

Every error names its code and links to it. All error codes

curl -X POST "https://api.ticketlayer.com/v1/reports/saved" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "description": "string",    "accountId": "string",    "query": {      "measures": [        "string"      ],      "dimensions": [        "string"      ],      "timeDimensions": [        {          "dimension": "string",          "granularity": "hour",          "dateRange": "string"        }      ],      "filters": [        {          "member": "string",          "operator": "string",          "values": [            "string"          ]        }      ],      "segments": [        "string"      ],      "order": {},      "limit": 0,      "offset": 0,      "timezone": "string"    },    "params": [      {        "kind": "timeRange",        "member": "string",        "label": "string",        "allowed": [          "string"        ]      }    ],    "viz": {      "type": "table",      "x": "string",      "y": "string",      "series": "string"    }  }'
Response 201
{
  "status": "success",
  "data": {
    "report": {
      "id": "rpt_abc12345",
      "organisationId": "string",
      "accountId": "string",
      "name": "Revenue by channel",
      "description": "string",
      "query": {},
      "params": [
        {}
      ],
      "viz": {},
      "createdBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Try it in test mode

Body