Skip to content

Get audits

POST
/audits
curl --request POST \
--url https://portal.staging.arago-tech.com/audits \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "keys": [ { "creative_id": "63e2d42a27ad5f2b345ca123", "dynamic_content_optimization_id": "63e2d42a27ad5f2b345ca123" } ] }'

Returns the audits of the given creatives and dynamic content optimizations.

The request to get the audits of the given creative and dynamic content optimization pairs

Media typeapplication/json
Get audits

The request to get the audits of the given creative and dynamic content optimization pairs

object
keys
required
Audit keys

The creative and dynamic content optimization pairs to get the audits of

Array<object>
>= 1 items <= 3000 items
Audit key

The creative and the dynamic content optimization the audits belong to

object
creative_id
required
Creative ID

The unique identifier of the creative in hexadecimal format

string
Example
63e2d42a27ad5f2b345ca123
dynamic_content_optimization_id
required
Dynamic Content Optimization ID

The unique identifier of the dynamic content optimization in hexadecimal format

string
Example
63e2d42a27ad5f2b345ca123

A successful response.

Media typeapplication/json
Get audits response

The response containing the audits

object
audits
Audits

The list of audits

Array<object>
Audit

Audit details

object
id
Audit ID

Unique identifier for the audit.

string
creative_id
Creative ID

The unique identifier of the creative in hexadecimal format

string
dynamic_content_optimization_id
Dynamic Content Optimization ID

The unique identifier of the dynamic content optimization in hexadecimal format

string
advertiser_domains
Advertiser Domains

List of advertiser domains associated with the audit

Array<string>
>= 1 items <= 10 items
ad_product_categories
Ad Product Categories

List of ad product categories associated with the creative. These are numeric identifiers representing different categories as per https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/develop/Ad%20Product%20Taxonomies/Ad%20Product%20Taxonomy%202.0.tsv.

Array<integer>
>= 1 items <= 10 items
feedback
Feedback

Feedback provided by the auditor.

string
status
Audit Status

The status of the audit.

string
default: AUDIT_STATUS_UNSPECIFIED
Allowed values: AUDIT_STATUS_UNSPECIFIED AUDIT_STATUS_PENDING AUDIT_STATUS_ESCALATE AUDIT_STATUS_BLOCK AUDIT_STATUS_PASS
created_at
Created at

The UTC created date of the audit

string format: date-time
updated_at
Updated At

The UTC last updated date of the audit

string format: date-time
Example
{
"audits": [
{
"id": "63e2d42a27ad5f2b345ca124",
"creative_id": "63e2d42a27ad5f2b345ca123",
"dynamic_content_optimization_id": "63e2d42a27ad5f2b345ca123",
"advertiser_domains": [
"example.com",
"another.example.com"
],
"ad_product_categories": [
1028,
1032
],
"feedback": "The creative is compliant with the guidelines.",
"status": "AUDIT_STATUS_UNSPECIFIED",
"created_at": "2023-01-01T00:00:00Z",
"updated_at": "2023-01-01T00:00:00Z"
}
]
}

Bad request

Media typeapplication/json
object
Example
{
"error": {
"code": "BAD_REQUEST",
"details": [
{
"code": "MAX_ITEMS",
"field": "line_items",
"message": "value must contain no more than 3000 item(s)",
"params": {
"max": "3000"
}
}
],
"message": "Bad request"
}
}

Unauthorized

Media typeapplication/json
object
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>
object
@type
string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}