Skip to content

Get impressions ranges

POST
/impressions-ranges
curl --request POST \
--url https://gateway.staging.arago-tech.com/impressions-ranges \
--header 'Content-Type: application/json' \
--data '{ "amounts": "1000.0", "currency": "CURRENCY_UNSPECIFIED" }'

Returns the impressions ranges

Returns impressions ranges from a slice of amounts in the given currency

Media typeapplication/json
Get impressions ranges

Returns impressions ranges from a slice of amounts in the given currency

object
amounts
required
Amounts

Slice of amounts to calculate the impressions ranges

Array<number>
Example
1000.0
currency
required
Currency codes as specified in ISO 4217 buf:lint:ignore ENUM_VALUE_PREFIX

Currency ID based on ISO 4217 numeric codes.

string
default: CURRENCY_UNSPECIFIED
Allowed values: CURRENCY_UNSPECIFIED ALL DZD ARS AUD BSD BHD BDT AMD BBD BMD BTN BOB BWP BZD SBD BND MMK BIF KHR CAD CVE KYD LKR CLP CNY COP KMF CRC HRK CUP CZK DKK DOP SVC ETB ERN FKP FJD DJF GMD GIP GTQ GNF GYD HTG HNL HKD HUF ISK INR IDR IRR IQD ILS JMD JPY KZT JOD KES KPW KRW KWD KGS LAK LBP LSL LVL LRD LYD LTL MOP MWK MYR MVR MRO MUR MXN MNT MDL MAD OMR NAD NPR ANG AWG VUV NZD NIO NGN NOK PKR PAB PGK PYG PEN PHP QAR RUB RWF SHP STD SAR SCR SLL SGD VND SOS ZAR SSP SZL SEK CHF SYP THB TOP TTD AED TND UGX MKD EGP GBP TZS USD UYU UZS WST YER ZMK TWD SLE VES CUC ZWL BYN TMT GHS VEF SDG UYI RSD MZN AZN RON CHE CHW TRY XAF XCD XOF XPF XBA XBB XBC XBD XAU XDR XAG XPT XPD XUA ZMW SRD MGA COU AFN TJS AOA BYR BGN CDF BAM EUR MXV UAH GEL BOV PLN BRL CLF XSU USN JEP IMP GGP BTC
Example
978

A successful response.

Media typeapplication/json
Get impressions ranges response

The response containing the impressions ranges

object
impressions_ranges
Array<object>
Impressions Range

Impressions ranges for a budget in USD

object
min_impressions
Min Impressions
string format: uint64
max_impressions
Max Impressions
string format: uint64
Example
{
"impressions_ranges": [
{
"min_impressions": 400,
"max_impressions": 800
}
]
}

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"
}
]
}