Skip to content
Dixa API/
/
Get record

Get record

Request

Get a single record's catalogue entry.

Security
ApiKeyAuth
Path
recordIdstringrequired

A record id from List Records

GET
/beta/intelligence/records/{recordId}
curl -i -X GET \
  'https://dev.dixa.io/beta/intelligence/records/{recordId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

One record's row fields, filters, anchors and the metrics derived from it

Bodyapplication/json
dataobject(RecordCatalogueEntry)required

One record's catalogue entry: what a client reads to understand and query the record, not its rows

Response
Both anchors, all seven secondary filters, and a tags field whose items are entity references
{
  "data": {
    "id": "closedConversations",
    "name": "Closed conversations",
    "category": "conversations",
    "description": "The conversations closed in the selected period, one row each",
    "deprecated": false,
    "primaryFilters": [ … ],
    "filters": [ … ],
    "fields": [ … ],
    "relatedMetricIds": [ … ]
  }
}