Skip to main content
POST
/
analytics
cURL
curl --request POST \
  --url https://api.slash.com/analytics \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>"
}
'
{
  "columns": [
    "<string>"
  ],
  "rows": [
    {}
  ],
  "rowCount": 123,
  "error": "<string>"
}

Authorizations

X-API-Key
string
header
required

API key authentication for public API requests.

Keys come in two flavors:

  • Legal-entity-scoped keys are pinned to a single legal entity. Minted via the dashboard under a specific entity; every request acts on that entity.
  • User-scoped keys are pinned to a user and span every legal entity that user has access to. Every request made with a user-scoped key (except GET /legal-entity, which lists the legal entities the user can access) must include an x-legal-entity header naming the legal entity the request is operating on. Requests without the header are rejected with 400. The authenticated user must have an active permission role on the supplied legal entity, otherwise the request is rejected with 403.

Body

application/json
query
string
required

SQL query to execute

Response

OK

columns
string[]
required

Ordered list of column names in the result set.

rows
object[]
required

Array of row objects keyed by column name.

rowCount
integer
required

Total number of rows returned.

error
string

SQL error message when the query fails.