List line items
const url = 'https://portal.staging.arago-tech.com/line-items';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://portal.staging.arago-tech.com/line-items \ --header 'Authorization: <Authorization>'Returns a list of line items
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters”Campaign IDs
List of campaign unique identifiers to filter line items by
Query
Search query to filter line items by name or other searchable fields
Statuses
List of statuses to filter line items by
From Date
Filter items with date on or after this timestamp
To Date
Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.
From Date
Filter items with date on or after this timestamp
To Date
Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.
Field
The field to sort by. This should be a valid field name in the context of the request.
Desc
The sort order. If true, the results will be sorted in descending order. If false, the results will be sorted in ascending order.
Offset
The offset of the first item
Limit
The maximum number of items to return (must be >= 10 and <= 1000)
Tags
List of tags to filter line items by
From Date
Filter items with date on or after this timestamp
To Date
Filter items with date strictly before this timestamp. Must be after ‘from’ when both are provided.
Responses
Section titled “ Responses ”A successful response.
Response containing a list of line items
object
List of line items
Line item information
object
The unique identifier of the line item in hexadecimal format
The campaign unique identifier
The name of the line item
The UTC start date of the line item
The UTC end date of the line item
The status of the line item
The unique identifiers of the creatives of the line item
The unique identifier of the targeting of the line item
The unique identifier of the dynamic content optimization of the line item
The unique identifier of the pricing policy of the line item
The unique identifier of the banker of the line item
The UTC creation date of the line item
The UTC last updated date of the line item
The tags associated with the line item
The unique identifier of the tracking of the line item
The spending cap of the line item
object
Total budget in the given currency, as entered
Currency ID based on ISO 4217 numeric codes
The budget converted to USD at the rate in force when its amount or currency last changed, net of the platform fee
Flag indicating if full text search has been performed
Example
{ "line_items": [ { "id": "63e2d42a27ad5f2b345ca123", "name": "Line Item 1" }, { "id": "63e2d42a27ad5f2b345ca124", "name": "Line Item 2" } ]}Bad request
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
object
Example
{ "error": { "code": "UNAUTHORIZED", "message": "Unauthorized" }}Internal server error
object
Example
{ "error": { "code": "INTERNAL_ERROR", "message": "Internal server error" }}default
Section titled “default”An unexpected error response.
object
object
Examplegenerated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}