Demand

Prerequisites

The Demand APIs use a header for authentication. Every call should have header specifying the token supplier-access-token: {token}.

In order to get a valid token, please contact demand-api@walr.com.

Overview

The Demand API allows users to interact with audience data. It provides functionalities to retrieve audience information, including details like status, country, language, and more.

Key Features:

• Retrieve Audience Data: You can get information about different audiences.
• Audience Details: The API returns details such as audience status, country, cost per interview, creation date, incidence rate, language, interview length, live URL, locale, name, quantity, and target end date.

Example of

{
  "id": "12345",
  "name": "Sample Audience",
  "audienceStatus": "Active",
  "countryName": "USA",
  "quantity": 100,
  "cpi": 2.5,
  "incidenceRate": 50,
  "lengthOfInterview": 15.0,
  "liveUrl": "https://example.com/live",
  "testUrl": "https://example.com/test",
  "createdUtc": "2024-06-12T08:48:39.542Z",
  "languageName": "English",
  "locale": "en-US",
  "targetEndDate": "2024-06-30T08:48:39.542Z",
  "targeting": {
    "existingId": "67890",
    "type": 1,
    "quotas": [
      {
        "questionId": "q1",
        "name": "Quota 1",
        "text": "Quota text"
        "localizedText": "Quota localized text",
        "targets": [
          {
            "id": "1",
            "targetCompletes": 50,
            "answers": [
              {
                "id": "1",
                "text": "Answer 1"
                "localizedText": "Answer localized text",
                "start": 1,
                "end": 10,
              }
            ]
          }
        ]
      }
    ],
    "screenings": [
      {
        "questionId": "2",
        "name": "Screening 1",
        "text": "Screening text"
        "localizedText": "Screening localized text",
        "isInclude": true,
        "answers": [
          {
            "id": "1",
            "text": "Screening Answer 1"
            "localizedText": "Screening answer localized text",
            "start": 1,
            "end": 10,
          }
        ]
      }
    ]
  }
}