API Overview

The Eskimi DSP API lets advertisers and agencies do through code what they do in the DSP: create and manage campaigns, creatives, audiences and packages, optimise delivery, and pull reports. It is for teams that want to automate their work or connect the DSP to their own tools.

What You Can Do With the API

AreaWhat you can do
CampaignsCreate and update banner, native and video campaigns; start, stop and delete them; read their status; change budget pacing (Even or None) without touching any other setting.
OptimisationRead campaign optimisation data, and start or stop delivery by exchange, creative, operating system, browser, operator, site or app, placement or package — the same actions as the Optimisation table in the DSP. Each option must be enabled for the advertiser.
PackagesCreate, list, rename and delete apps/sites or placement packages, and add or replace their domains (up to 50,000 per request).
CreativesCreate, update, list and delete creative sets and creatives; upload banner and native assets.
AudiencesCreate, update and delete behavioural and DMP audiences; list audience interests.
Brand safetyCreate and list brand safety keyword sets.
ReportsCampaign reports and their splits (sites, exchanges, creatives, operating systems, operators, browsers, placements, age, gender and more), video reports, device ID reports, and period totals including deduplicated reach.
Reference dataThe IDs that campaign settings use: countries and states, operators, devices, exchanges, sites, ad placements, age groups, genders and private marketplaces.
InvoicesInvoice details and the invoice PDF.

The full list of endpoints, parameters and examples is in the API documentation: https://dsp-api.eskimi.com/docs/api/v1/

How Access Tokens Work

Every API call needs an access token. The token tells the API who is calling and what that account may do.

How access tokens work: 1. request a token, 2. call the API with the token, 3. request a new token before it expires

  1. Get an access token: generate it in the DSP, or request it with an HTTP call. Both ways are described in How to Use the API.

  2. Send the token in the Authorization header of every call: Authorization: Bearer {ACCESS_TOKEN}

  3. A token is valid for one year. When you request it with an HTTP call, the response states its lifetime in seconds (expires_in). Before it expires, request a new token the same way and use the new one from then on.

The token belongs to your user and works for every advertiser your user has access to. Choose the advertiser with the advertiserId parameter in each request.

Working With the API

A few conventions apply to every endpoint:

Common Errors

CodeWhat it meansWhat to do
400The request data is invalid, or the action is not possible for this campaign.Read the error message in the response; it names the field or the reason.
401The access token is missing or has expired.Check the Authorization header. If the token is older than a year, request a new one.
403Your user has no access to this advertiser.Ask an admin of your account to give your user access to the advertiser.
422A value is outside what the endpoint accepts.Check the allowed values for that field in the API documentation.

Matching the API to DSP Reports

API reports use the same data as the DSP. When the figures differ, one of these settings is usually the reason:

Keeping Your Credentials Safe

For step-by-step campaign set-up through the API, see How to Launch a Campaign with the API. Quick answers to common questions are in FAQ: Eskimi DSP API.

Summary

The API covers campaigns, optimisation, packages, creatives, audiences, brand safety, reports and invoices. Get a token once, send it with every call, and renew it before it expires. For a ready-made set of requests, see API Postman Template.


Revision #10
Created 26 October 2021 08:41:47 by Hasnain Shahriar
Updated 23 October 2026 10:03:36 by Roberta Karpoviciute