Skip to main content

API Overview

The

Eskimi DSP API provideslets rangeadvertisers 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 dspendpoints, dashboard related solutions to dsp clients of the online sphere. This allowes dsp clients to avail dashboard services through API without needing to use DSP dashboard platform.

Available services

Campaign
Campaign creationparameters and relatedexamples servicesis needed to create campaign.

Audience
Audience creation and related services needed to create audience

Creative
Creative creation and related services needed to create campaign.

Report
Different report fetching for corresponding campaign.

Auth access token management overview

DSP API auth access tokens are credentials to access DSP APIs. These tokens informin the API thatdocumentation: https://dsp-api.eskimi.com/docs/api/v1/

How Access Tokens Work

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

token_management_flow.png

  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 has been permitted to access the API and perform different actions according to the allowed scope.

Auth access token management flow

Access token creation activities are initiated by the client system. The following flow describes the token life cycle -
token_management_flow.png

Auth access Token Management Steps

  • Before accessing any DSP APIs, call the Get Access Token API to get authorization token.
  • Use this token value in the "Authorization"Authorization header forof accessingevery futurecall: APIAuthorization: calls.Bearer {ACCESS_TOKEN}

  • Before

    A token is valid for one year. When you request it with an HTTP call, the endresponse ofstates the current tokenits lifetime Getin Accessseconds Token(expires_in). APIBefore againit toexpires, getrequest a new token againstthe yoursame existingway token. You will have toand use the new one from then on.

    • From a parent account, the same token foralso subsequentgives otheraccess to the data of its child accounts.

    Summary

    The API calls.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.

Back to top