The Adverity Management API facilitates usage of the Adverity platform entirely through the Management API, as an alternative to direct interaction with the Adverity UI.
All actions that can be carried out in the Adverity user interface (UI) can also be carried out through the Management API (e.g. creating streams, fetching data, etc). Initially, it might make sense to use Adverity's UI to become familiar with all elements and their functionality.
- The URL of your instance (stack) (e.g. YOUR_STACK.datatap.adverity.com).
- User Access Credentials.
Throughout the Management API documentation, we provide example code blocks to illustrate calls made to the API, and responses received in return.
Blue code blocks show input commands.
Green code blocks show response results from the API.
In addition to the above, our code examples also use two main placeholders that will need to be replaced with details specific to your Adverity instance:
- Placeholders in block capitals represent a fixed value unique to your specific Adverity Workspace.
(e.g. "YOUR_STACK" always represents the URL address of your Adverity Stack).
- Additionally, we will call attention to some fields or variables that are key to the process being described, these are highlighted in bold and italicized.
(e.g. when making a query relating to an ID field, we may choose a arbitrary placeholder such as "123").
- Where appropriate, the above two codes may be used together
(e.g. when describing the process to retrieve an authorization token, the token value will be shown as TOKEN_VALUE as it is both a placeholder, and a value that will be individual to your Adverity stack).
All timestamps passed to the API need to be in UTC and use the following format:
%Y-%m-%dT%H:%M:%SZ e.g. 2019-02-01T12:00:22Z
If results contain multiple pages, the parameters next and previous will contain the relevant URLs. If results fit on one page, these parameters will still be present, but contain null values.
Additionally, the page_size parameter may be used to decrease/increase the number of results per page.
Certain elements have slightly different names in the UI vs the API:
|UI Name||API Name|
|Data Schema Column||Target Column|