Skip to content

List campaigns

GET
/line-items/campaigns
curl --request GET \
--url https://gateway.staging.arago-tech.com/line-items/campaigns

Returns a list of campaigns

query
string

Query

Search query to filter campaigns by name, description or other searchable fields

statuses
Array<string>
Allowed values: STATUS_UNSPECIFIED STATUS_PAUSED STATUS_PLAYING

Statuses

List of statuses to filter campaigns by. A campaign matches when its aggregated status is one of them. A playing or paused campaign whose latest line item end date has passed matches none of them

start_date_range.from
string format: date-time

From Date

Filter items with date on or after this timestamp

start_date_range.to
string format: date-time

To Date

Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.

end_date_range.from
string format: date-time

From Date

Filter items with date on or after this timestamp

end_date_range.to
string format: date-time

To Date

Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.

sort.field
string

Field

The field to sort by. This should be a valid field name in the context of the request.

sort.desc
boolean

Desc

The sort order. If true, the results will be sorted in descending order. If false, the results will be sorted in ascending order.

pagination.offset
integer format: int64

Offset

The offset of the first item

pagination.limit
integer format: int64

Limit

The maximum number of items to return (must be >= 10 and <= 1000)

tags
Array<string>
<= 10 items unique items

Tags

List of tags to filter campaigns by

created_at_date_range.from
string format: date-time

From Date

Filter items with date on or after this timestamp

created_at_date_range.to
string format: date-time

To Date

Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.

A successful response.

Media typeapplication/json
List campaigns response

The response containing the campaigns

object
campaigns
List campaigns

The list of campaigns

Array<object>
object
id
Campaign ID

The campaign unique identifier

string
name
Name

The name of the campaign

string
>= 1 characters <= 255 characters
description
Description

The description of the campaign

string
>= 1 characters <= 1024 characters
created_at
Created At

The creation date and time of the campaign

string format: date-time
updated_at
Updated At

The last update date and time of the campaign

string format: date-time
start_date
Start date

The earliest start date of line items in the campaign

string format: date-time
end_date
End date

The latest end date of line items in the campaign

string format: date-time
line_item_count
Line item count

The total number of line items in the campaign

integer format: int64
status
Status

The aggregated status of the campaign based on line item statuses

string
default: STATUS_UNSPECIFIED
Allowed values: STATUS_UNSPECIFIED STATUS_PAUSED STATUS_PLAYING
full_text_search
Full Text Search

Flag indicating if full text search has been performed

boolean
Example
{
"campaigns": [
{
"id": "63e2d42a27ad5f2b345ca123",
"name": "Discount on products"
},
{
"id": "63e2d42a27ad5f2b345ca124",
"name": "New Year Sale"
}
]
}

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