Version {{ version }}
\nWelcome to the AiAdvertising Platform API. You can use this api to programmatically access and manage your organization's Ai Ad Platform instance.
\nYou can view code examples in the programming language of your choice by selecting the options in the navigation bar above.
\nThe API URL structure follows typical resource-oriented conventions.
\nTo get a list of Campaigns, use the following:
\nGET https://api.aiadvertising.com/campaigns
This returns a list of Campaign objects, where each campaign has an id attribute. To get details on the campaign by id, use the following (be sure to replace with an actual id):
\nGET https://api.aiadvertising/campaigns/{id}
The Ai Ad Platform uses a combination of HTTP status codes and custom error codes with a descriptive message in JSON-formatted Error objects to give you a more complete picture of what has happened with your request.
\nUnless otherwise specified, all API endpoints expect request body data to be in JSON, and the response body data is returned as JSON.
\nThe following HTTP request headers may be required, depending on the operation and endpoint being used:
\nAIAD uses a json web token based approach to authentication and data access. Once a user is logged in, AIAD creates a new JWT referencing the user. This token is required when making subsequent REST requests for the access control system to validate that the user can invoke methods on a given Model
\nYou can pass the token via the Authorization header as a Bearer Token
\nAs Authorization Header
\ncurl -X GET -H \"Authorization: Bearer \"bGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Im1xOUZjcU95MWxZcG...\"
Be sure to replace with a valid token
\nUse filters with queries to scope what data is returned from the API.
\nWhen querying models, filters specify criteria for the returned data set. You can use filters to scope down the returned results, select specific fields, sort results, or apply pagination.
\nFilters can be used when querying AiAdvertising models as well as records that come from external sources.
\nAiAdvertising supports a specific filter syntax: it's based on the MongoDB Query Syntax, but is designed specifically to serialize safely without injection. You can use any number of filters to define a query. The types are as follows:
\nA filter specifies a set of logical conditions to match, similar to a WHERE clause in a SQL query. The where filter is formatted as following:
\nWithout an attribute defaults to equivalence
\n?filter={\"field\": \"value\"}
With an operator (see below for more details)
\n?filter={\"field\": {\"operator\": \"value\" }}
To pass the filter object to the api, you should send the filter as a \"stringified json\" query parameter.
\nGET https://api.aiadvertising.com/campaigns/${JSON.strigify(filterObject)}
Building a stringified json object is straightforward. You can build your filter as a normal object and then use a JSON.stringify() command to \"stringify\" the filter object.
\nFor the full list of supported MongoDB Filter Operators - see their documentation
\nThis table describes the operators available in filters.
\nUse the fields query param to limit what fields are returned from the api. If the field filter is not included, the api will return all fields for a resource
\nYou should pass fields as a comma separated list of fields
\n?fields=id,size,brand
You can also use the - prefix to return all fields except some specific fields
\n?fields=-id,-size
An order query param specifies how to sort the results: ascending (ASC) or descending (DESC) based on the specified property.
\nYou can pass either a single string or a comma separated list of strings
\nOrder by one property
\n?order=name
Order by two or more properties
\n?order=name,size
You can use the - prefix to sort in descending order
\n?order=-name,-size
A skip query param omits the specified number of returned records. This is useful, for example, to paginate responses.
\n?skip=50
This skips the first 50 records returned
\nA limit query param limits the number of records returned to the specified number (or less)
\nYou can pass either an array or an object with boolean values
\n?limit=50
This returns only the first 50 records (or less).
\nNote - The max limit 500. If you need to fetch more than 500 records, you will need to make additional api calls.
\nAn include query param allows you to include related sub models in your request
\nFor Example, to include attachments for a given Asset you could use the the follow query
\n?include=attachments
This will return Assets with any related Attachments in an array as attachments.
\nThe Ai Ad Platform uses a technique call \"Soft Deletion\" that allows you to archive records without actually removing them from the database. If you would like to include archived records in your queries - you should append the archived query param with a true value.
\n?archived=true
This will return Assets with any related Attachments in an array as attachments.
\nUser types determine at an application wide level what a user can access & do.
\nThe Ai Ad Platform API returns all dates and times in the UTC time zone in ISO-8601 format, that is, YYYY-MM-DDTHH:MM:SSZ. If a date/time needs to be displayed to an end-user in their local time zone, you must do the conversion using the user's time zone
\nTo prevent abuse and undue stress on the Ai Ad Platform servers, the API has a rate limiting feature that restricts users to 100 requests per minute per access token.
\nAiAdvertising reserves the right to enforce this limit depending on the load on our systems. If and when the limit is enforced, any requests that exceed this limit are rejected with an 429 HTTP status code, along with the following JSON response body:
\n{ \"errorCode\": 409, \"message\": \"Rate limit exceeded.\" }
AiAdvertising recommends that you design your integration to gracefully handle this rate limit error.
\nAiAdvertising will add new functionality and bug fixes to the API over time. Be sure that your code can handle new JSON properties gracefully. Also, make sure your code does not depend on the order in which JSON objects are returned, unless it is explicitly stated in this documentation.
\nWe take security very seriously at AIAD. We have taken many parameters to ensure our users data is safe and secure. This includes:
\nYour Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Analytics provide a high level overview of your advertising performance.
\n","_postman_id":"f42f7110-e20a-4070-89b6-340bf6725bed"},{"name":"Assets","item":[{"name":"Find All Assets","id":"17cadef3-e914-491b-b073-c58da99f7556","request":{"auth":{"type":"bearer","bearer":{"token":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"Assets refers to the various digital media that are used within a particular campaign. These assets include the visual, audio, video, and other formats that can be deployed through a campaign.
\n","_postman_id":"d3ddde6a-e035-44f7-90c3-a828ba3c8210"},{"name":"Attachments","item":[{"name":"Find All Attachments","id":"4805301a-a804-4d19-92ad-fd93e40a42a1","request":{"auth":{"type":"bearer","bearer":{"token":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"(Required)
\n","type":"text/plain"},"key":"archived","value":"Your Workspace ID
\n","key":"X-WORKSPACE-SLUG","value":"Your AIAD Organization ID
\n","key":"X-ORGANIZATION-SLUG","value":"