Skip to content

Portal API Overview

The Portal API is Arago DSP’s external partner-facing API designed for programmatic campaign lifecycle management. It enables partners to create, update, retrieve, and monitor advertising campaigns and their underlying line items through an intuitive, streamlined REST interface.

Simplified Campaign Lifecycle

Create a campaign with its line items in a single call via POST /line-items/campaigns and manage line items in bulk via PUT /line-items.

Bulk Line Item Management

Create or update up to 3,000 line items per call and delete them in bulk.

Strict Data Validation

Strict field boundaries and date constraints validated server-side with structured error envelopes.

Interactive OpenAPI Reference

Full interactive schema reference generated from live protobuf definitions with cURL and JavaScript code snippets.


The Portal API uses API Key Bearer Authentication. All API requests must include your designated partner API key in the standard Authorization header:

Authorization: Bearer <YOUR_PARTNER_API_KEY>

Requests submitted without a valid API key, or with an unrecognized key, will immediately fail with a 401 Unauthorized status.


Retrieve paginated campaigns owned by your organization:

List campaigns
curl -X GET "https://portal.staging.arago-tech.com/line-items/campaigns?pagination.offset=0&pagination.limit=10" \
-H "Authorization: Bearer <YOUR_PARTNER_API_KEY>"

Example response:

Response: 200 OK
{
"campaigns": [
{
"id": "63e2d42a27ad5f2b345ca123",
"name": "Summer 2026 Brand Campaign",
"start_date": "2026-08-01T00:00:00Z",
"end_date": "2026-10-31T00:00:00Z",
"status": "STATUS_PLAYING",
"line_item_count": 3,
"created_at": "2026-07-15T10:00:00Z",
"updated_at": "2026-07-20T14:30:00Z"
}
],
"full_text_search": false
}

Create a campaign and its initial line items with POST /line-items/campaigns. You must provide at least one line item:

Create campaign
curl -X POST https://portal.staging.arago-tech.com/line-items/campaigns \
-H "Authorization: Bearer <YOUR_PARTNER_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"name": "Autumn Retargeting 2026",
"line_items": [
{
"name": "Web Native 300x250",
"start_date": "2026-09-01T00:00:00Z",
"end_date": "2026-10-15T00:00:00Z",
"budget": {"amount": 1000, "currency": "EUR"}
}
]
}'

To update an existing campaign’s name or description, execute a PATCH /line-items/campaigns/{id} call:

Update campaign
curl -X PATCH https://portal.staging.arago-tech.com/line-items/campaigns/63e2d42a27ad5f2b345ca123 \
-H "Authorization: Bearer <YOUR_PARTNER_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"name": "Autumn Retargeting 2026 - Extended"
}'

Line items are managed separately: use PUT /line-items to create or update them in bulk (up to 3,000 per request) and DELETE /line-items to remove them.

Fetch a specific campaign with its derived flight dates, status and line item count:

Get campaign by ID
curl -X GET https://portal.staging.arago-tech.com/line-items/campaigns/63e2d42a27ad5f2b345ca123 \
-H "Authorization: Bearer <YOUR_PARTNER_API_KEY>"

Explore the detailed specifications: