GuidesAPI Reference
API Reference

Gets the partitions that match the query

Queries the index layer for the partitions that match the query. Returns each partition that matches the query, including each partition's data handle, which you use with the blob API to retrieve data for each partition.

Path Params
string
required

The ID of the index layer you want to query.

Query Params
string
required

An RSQL query to use to retrieve partitions that match the query. For more information, see Get Index Data from an Index Layer. The query must use the indexing attributes defined in the index layer.

string

Indicates which part of the layer shall be queried.

string

Billing Tag is an optional free-form tag which is used for grouping billing records together. If supplied, it must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]. Grouping billing records by billing tag will be available in future releases.

Responses

400

Bad Request - The request is invalid. Verify and retry.

401

Unauthorized - The credentials provided do not authorize the user to perform this operation.

403

Forbidden - The user is not authorized to perform the query on the resource specified.

404

Not Found - The criteria set in the query is not valid.

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json