Skip to main content

How to Use the API

UsingThis page shows how to start using the Eskimi DSP API: create an API oneclient, get an access token and make your first call. For what the API can getdo, analyticssee of Eskimi platform as well as do other operations like creating campaigns etc. In this article the steps of using API is described. Overview.

Create an API Client Secret from Eskimi profile:

    1. In the dashboardDSP, UIclick page,the three-dot icon in the top right corner click the three dot icon.corner.

    2. Click on "API Clients"Clients.

    3. In

      Click APIAdd Clients UI page,Client in the top right corner click "Add Client".corner.

    4. Enter thea Client name (Theany namename; doesit is not matter, it won't be used forin the access token), and click on "Generate"Generate fornext to Client Secret.

    5. Click Save. theThe changesclient is created, and theyou APIcan clientnow willget bean createdaccess that will be usedtoken for getting Access Token.

    it.

ScreenRecording2024-04-11at10.44.19-ezgif.com-video-to-gif-converter.gif

Once

Get you have created API Client you can createan Access Token for it.

Create Access Token

There are 2two ways onto creatingget Accessa Token:token. Both give a token that is valid for one year.

a. In 1.the Create Access Token through Eskimi DSP:DSP

      1. After saving press

        Click the three three-dot icon onnext theto rightyour ofclient, the desiredthen Client.Edit.

      2. Click on "Edit".

      3. Now you should be able to click "Generate Client Token" button..

      4. Enter your account password for security reasons and click "Confirm Identity & Generate".

      5. Click Client's TokenCopy willto bekeep generatedthe andtoken, then click "Copy" Saveto save and use it later. 

      6. Click Save
    .

image.png

Token

b. expirationWith term: 1 year.

     2. Create Access Token throughan HTTP Request

Send

    a
  • GetPOST accessrequest token.to Forhttps://dsp-api.eskimi.com/api/oauth/token gettingwith accessthis tokenbody the documentation is provided here:(documentation: https://dsp-api.eskimi.com/docs/api/auth/
):

{
  "grant_type": "eskimi_dsp",
  "username": "dsp_username",
  "password": "Password",
  "client_id": client_id,
  "client_secret": "client_secret"
}

AThe requestresponse examplecontains forthe reportingaccess_token endpoints:and its lifetime in seconds (expires_in). Request a new token the same way before it expires.

Make Your First Call

Send the token in the Authorization header. For example, a campaign report:

curl 'https://dsp-api.eskimi.com/api/v1/report/campaigns/get?advertiserId=1&byDate=1&byCampaign=1&dateFrom=2026-01-01&dateTo=2026-01-30' \
-H 'authorization: Bearer {ACCESS_TOKEN}'

From youra parent account, you can access your child accountaccounts' data via API.


  • After gettingwith the accesssame tokentoken.

    API

    All canendpoints, beparameters usedand usingexamples are in the access token. The API documentation: https://dsp-api.eskimi.com/docs/api/v1/

  • .
  • PleaseTo watchtry them without writing code, import the API Postman Template.

    Watch the video tofor understanda the process better:

walk-through:


What

the API Limitations:

Can and Cannot Do

  • Campaigns, packages, creatives, audiences, brand safety sets and optimisation (start or stop by exchange, creative, operating system, browser, operator, site or app, placement or package) can all be managed through the API. See API Overview for the full list.

  • Video campaigns can be created viathrough API.the However,API, but video creatives must first be uploaded in the DSP UI, asDSP: the API doesuploads notbanner currentlyand supportnative videoassets or VAST asset uploads.
    only.

  • Not allevery reporting splitssplit arein the DSP is available in the reportingAPI. API endpoints, you can see allThe available splits are listed here.

  • Total reach canfor bea retrievedperiod viacomes APIfrom /report/totals and should match thematches DSP reporting. PleaseDo notenot thatadd up the daily reach values from the split endpointsreports: shouldone notuser beis summed.
    counted again on every day they were reached.

  • Reports can return spend in USD or in the advertiser’advertiser's local currency, depending on the spentBased parameter. 

Summary

Create an API client in the DSP, get a token (in the DSP or with an HTTP request), and send it with every call. Renew the token before it expires after one year.