Getting Started with Claravine
An overview of Claravine's APIs
Claravine offers two APIs that allow customers to implement their own custom solutions that interface with Claravine.
- The Data Standards Cloud API is a secure REST API focused on submissions: create submissions, view submissions, and search for specific data across submissions.
- The Classification API enables the classification of content and creative assets.
Details about all API endpoints are available here.
Availability of The Data Standards Cloud API is tied to your platform contract tier and must be enabled on your account by your CSM. The Classification API is a separate paid contract. Please reach out to your CSM and/or Account Executive for more details about using the APIs.
Available endpoints include:
Data Standards Cloud API
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 Data Standards Cloud 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.
List Datasets:
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.
Create Transaction:
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).
Transaction Status:
Get the current status of a transaction. May return a status of 'Pending', 'Complete', or 'Failed'.
Transaction Data:
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.
Classification API
Content Similarity:
For each endpoint, there is an additional module for content similarity. This is supported by the Summary and Creative APIs.
Audio Transcription:
For each endpoint, there is an additional module for audio transcription. This is supported by the Summary and Creative APIs.
Classify Creative Content:
The Creative endpoint uses Claravine AI to classify creatives (video and image) along with associated metadata when available.
Classify Publisher Media Content:
The Summary endpoint uses Claravine AI to classify content (video and image) along with associated metadata when available.
Classify Livestream Content:
The Livestream endpoint uses Claravine AI to classify streaming video content along with associated metadata when available.
Updated 9 months ago