Steps of using API

Using API one can get analytics of Eskimi platform as well as do other operations like creating campaigns etc. In this article the steps of using API is described. 

Create API clientClient secret and tokenSecret from Eskimi profile:

1. 1. In the dashboard UI page, in the top right corner click the three dot icon.
   2. Click on "API Clients".
   3. In API Clients UI page, in the top right corner click "Add Client".
   4. Enter the Client name (The name does not matter, it won't be used for the access token), and click on "Generate" for Client Secret.
   5. Save the changes and the API client will be created that will be used for getting Access Token.

Once you have created API Client you can create Access Token for it.

Create Access Token

There are 2 ways on creating Access Token:

     1. Create Access Token through Eskimi DSP:

1. 1. 1. After saving press the three dot icon on the right of the desired Client.
      2. Click Saveon button"Edit".
      3. After refresh,Now you willshould be able then to click "Generate Client Token" button.
      4. Enter your account password for security reasons and click "Confirm Identity & Generate"
      5. YourClient's tokenToken will be generated and click "Copy" to save and use it for later. 
      6. Click Save

Token expiration term: 1 year.

     2. Create Access Token through HTTP Request

Create API client secret from Eskimi profile and create token through API:

1. 1. In the dashboard UI page, in the top right corner click the three dot icon.
   2. Click on "API Clients".
   3. In API Clients UI page, in the top right corner click "Add Client".
   4. Enter the Client name (The name does not matter, it won't be used for the access token), and click on "Generate" for Client Secret.
   5. Save the changes and the API client will be created that will be used for getting Access Token.

       

• Get access token. For getting access token the documentation is provided here: 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"
}

A request example for a reporting endpoints:

{ 
  "campaignIds": [ 
    000000 
  ], 
  "dateFrom": "2023-05-08", 
  "dateTo": "2023-05-12", 
  "byDate": true, 
  "byCampaign": false
}

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

---

• After getting the access token API can be used using the access token. The API documentation: https://dsp-api.eskimi.com/docs/api/v1/
• Please watch the video to understand the process better:

---

API Limitations:

• Currently you're able to create only Banner or Native type campaigns via API, currently we do not have functionality to create Video type campaigns.
• Not all reporting splits are available in the reporting API endpoints, you can see all available splits here.
• Total reach numbers will be different from the reports and the API, as dashboard reporting using different logic for counting reach (This is being worked on, so total reach numbers would match API and  dashboard reporting part).
  
• Currently there is no current endpoint, everything is being reported with $.