Overview
The Discovery API is a read-only batch API that allow developers to get lists of Mode resources, along with metadata about each of those resources. The API will be referred to as ‘batch’ throughout the documentation. The resources currently supported are Reports, Spaces, Queries and Charts. See the full documentation for the Discovery API here.
Note: To create a valid Signature Token for accessing the Discovery API, an organization admin’s api key & secret are required for authenticating the token creation endpoint. The organization must have an active, paid plus subscription. All other endpoints will require a valid Batch API Signature Token for access.
Authentication & authorization
To return a valid signature token (to then be used for Batch API requests) send a POST request.
signature_token
should be a top level key in the raw data sent.
name
is required to be a string between 4-64 characters longexpires_at
must be in ISO8601 (YYYY-MM-DDTHH:mmZ) formatauth_scope
must be a JSON object.authentication_for
andauthorization_type
are the only valid keys.batch-api
is the only valid value forauthentication_for
.read-only
is the only valid value forauthorization_type
.
Last updated August 18, 2020