API Overview
This page gives an overview of APIs.
You can query or manipulate any data on the Cinchy Platform using the Cinchy Query Language (CQL). You can then save that as a Saved Query which allows it to be accessed via an API endpoint.
You will need to first a Cinchy bearer token (see Authentication), and then you can either access a pre-defined Saved Query via the Saved Query endpoints, or perform freeform querying via the ExecuteCQL endpoint.
Note that regardless of how you query or manipulate data on the platform, it is always associated back to an account.
The following is a list of common API endpoints. These follow the format of <baseurl>/endpoint
Description |
---|
This endpoint will bring you to a page with your logs and health check. |
Description |
---|
This endpoint will open the model loader. |
Description |
---|
This endpoint will bring you to a page with your platform health check. |
Description |
---|
This endpoint will delete your platform cache data. |
Description |
---|
You can execute CQL directly without creating a Saved Query using the below endpoint: |
Query Parameters:
Name | Data Type | Description |
---|---|---|
CompressJSON | boolean | Default is true. Add this parameter and set to false if you want the JSON that is returned to be expanded rather than having the schema being returned separately. |
ResultFormat | string | XML
JSON
CSV
TSV
PSV
PROTOBUF |
Type | string | QUERY
- Query (Approved Data Only)
DRAFT_QUERY
- Query (Include Draft Changes)
SCALAR
- Scalar
NONQUERY
- Non Query, such as an insert or delete
VERSION_HISTORY_QUERY
- Query (Include Version History) |
ConnectionId | string |