The API is intended to manage data in Claravine's platform, The Data Standards Cloud. In the future, there will be additional API endpoints for other Claravine features.
For access to the API, you will need to contact your Customer Success Manager and assign a user account to be granted API access.
List Dataset Transactions:
Get a list of transactions (including submissions through the UI) associated with a dataset. Each of these transaction UUIDs may be used to fetch specific data associated with that transaction.
Look up transaction row by generated pattern:
Get dataset rows that match a specific Claravine Pattern (sometimes referred to as tracking codes).
There should normally be 1 or 0 results. In the event of multiple matches, up to 100 results may be returned.
Get all datasets available to the authenticated user. In The Data Standards Cloud UI, these are templates. All returned fields can have values submitted to them. There are other fields on the datasets, but they are read-only and not made visible through this endpoint.
Post data to a specific dataset. Data will be processed according to Governance Rules defined in the related dataset (template in The Data Standards Cloud UI). If any data fails when tested against Governance Rules, the entire dataset will be moved into the draft/pending state, and no attached integrations will be run. If no data fails, integrations will be executed as defined in the dataset (template in The Data Standards Cloud UI).
Get the current status of a transaction. May return a status of 'Pending', 'Complete', or 'Failed'.
Get the data of a completed transaction (not available before the transaction has been completed). Returns all available fields and data associated with each field, including read-only fields and data.
The default rate limit is 100 requests per minute, which is shown through the response headers X-RateLimit-Limit and X-RateLimit-Remaining.
API keys and secrets are generated in The Data Standards Cloud UI, and they are given the same permissions as the user who created them. Talk to your CSM for additional information.