Skip to content

Upsert trackings

PUT
/trackings
curl --request PUT \
--url https://gateway.staging.arago-tech.com/trackings \
--header 'Content-Type: application/json' \
--data '{ "trackings": [ { "id": "63e2d42a27ad5f2b345ca123", "double_trackings": [ { "source_url": "example", "url": "example", "type": "DOUBLE_TRACKING_TYPE_UNSPECIFIED", "vendor_id": 1 } ] } ] }'

Creates or updates multiple trackings

Request to upsert trackings

Media typeapplication/json
Upsert trackings

Request to upsert trackings

object
trackings
required
Trackings

List of trackings to upsert

Array<object>
>= 1 items <= 3000 items
Tracking

Tracking details for upsert

object
id
Tracking ID

The tracking unique identifier. If not provided, a new tracking will be created.

string
Example
63e2d42a27ad5f2b345ca123
double_trackings
required
Double trackings

The third party trackers fired alongside the ad. The url and vendor_id of each entry are generated from the source URL and ignored on input

Array<object>
>= 1 items <= 10 items
object
source_url
string
url

Url is server generated, ignored on input.

string
type

DoubleTrackingType represents the type of double tracking mechanism.

string
default: DOUBLE_TRACKING_TYPE_UNSPECIFIED
Allowed values: DOUBLE_TRACKING_TYPE_UNSPECIFIED DOUBLE_TRACKING_TYPE_IMG DOUBLE_TRACKING_TYPE_SCRIPT
vendor_id

Vendor_id is server generated, ignored on input.

integer format: int64

A successful response.

Media typeapplication/json
Upsert trackings response

Response containing the upserted trackings

object
trackings
Trackings

List of trackings

Array<object>
Tracking

The tracking information referenced by line items

object
id
Tracking ID

The tracking unique identifier in hexadecimal format

string
double_trackings
Double trackings

The third party trackers fired alongside the ad. The url and vendor_id of each entry are generated from the source URL and ignored on input

Array<object>
>= 1 items <= 10 items
object
source_url
string
url

Url is server generated, ignored on input.

string
type

DoubleTrackingType represents the type of double tracking mechanism.

string
default: DOUBLE_TRACKING_TYPE_UNSPECIFIED
Allowed values: DOUBLE_TRACKING_TYPE_UNSPECIFIED DOUBLE_TRACKING_TYPE_IMG DOUBLE_TRACKING_TYPE_SCRIPT
vendor_id

Vendor_id is server generated, ignored on input.

integer format: int64
provider_id

Provider_id is server generated, ignored on input.

string
created_at
Created At

The creation date and time of the tracking

string format: date-time
updated_at
Updated At

The last update date and time of the tracking

string format: date-time
Example
{
"trackings": [
{
"id": "63e2d42a27ad5f2b345ca123",
"double_trackings": [
{
"type": "DOUBLE_TRACKING_TYPE_UNSPECIFIED"
}
],
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}
]
}

Bad request

Media typeapplication/json
object
Example
{
"error": {
"code": "BAD_REQUEST",
"details": [
{
"code": "PATTERN",
"field": "username",
"message": "does not match regex pattern `^[a-zA-Z]*$`"
},
{
"code": "MIN_LEN",
"field": "username",
"message": "must be at least 3 characters",
"params": {
"min": "3"
}
}
],
"message": "Bad request"
}
}

Unauthorized

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

Forbidden

Media typeapplication/json
object
Example
{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
}
}

Not found

Media typeapplication/json
object
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL",
"details": [
{
"code": "INTERNAL",
"field": "line_items[0]",
"message": "Couldn't upsert line item"
},
{
"code": "INTERNAL",
"field": "line_items[380]",
"message": "Couldn't upsert line item"
}
],
"message": "Internal server error"
}
}

Gateway timeout

Media typeapplication/json
object
Example
{
"error": {
"code": "TIMEOUT",
"details": [
{
"code": "TIMEOUT",
"field": "request",
"message": "Request processing time exceeded deadline",
"params": {
"duration": "30s"
}
}
],
"message": "Gateway timeout"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field.

Protobuf APIs provide utilities to interact with Any values:

  • A ‘pack’ operation accepts a message and constructs a generic Any wrapper around it.
  • An ‘unpack’ operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url.
  • An ‘is’ operation decides whether an Any contains a message of the given type, i.e. whether it can ‘unpack’ that type.

The JSON format representation of an Any follows one of these cases:

  • For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL.
  • For types with special-cased JSON encodings (typically called ‘well-known’ types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value.

The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.

object
@type

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}