Reference Guide
Start typing to search…

Getting Started with ADP API

Learn how to authenticate and make your first API call in under 10 minutes

Getting Started with ADP API

New to the ADP API? This guide will get you authenticated and making successful API calls within 10 minutes.

What You'll Learn

Prerequisites

Before you begin, you'll need:

  1. CLIENT_LOGIN - Your client login credential
  2. CLIENT_TOKEN - Your authentication token
  3. NETWORK ID - Your network identifier (e.g., 7012768)

Don't have credentials? Contact [email protected] to request access.

Quick Start (5 Minutes)

Step 1: Configure Authentication Headers

Add these headers to all API requests:

x-internal-auth-login: {CLIENT_LOGIN}
x-internal-auth-token: {CLIENT_TOKEN}
content-type: application/json

Step 2: Test Your Connection

Send this query to verify authentication:

{
  network {
    network_id
    network_name
  }
}

Expected Response:

{
  "data": {
    "network": {
      "network_id": "NT-7012768",
      "network_name": "Demo Network"
    }
  }
}

✅ Success! You're authenticated and ready to explore the API.

API Structure Overview

The ADP API organizes operations into 8 domain root fields:

graph TD
    API[ADP API] --> dream_adserver[dream_adserver<br/>Core Operations]
    API --> report[report<br/>Reporting]
    API --> inventory_manager[inventory_manager<br/>Inventory]
    API --> dream_audience[dream_audience<br/>Audience]
    API --> user_manager[user_manager<br/>Users]
    API --> video[video<br/>Video Ads]
    API --> crm[crm<br/>CRM]
    API --> mia[mia<br/>Analytics]
    
    dream_adserver --> deals[Deals]
    dream_adserver --> lineitems[Line Items]
    dream_adserver --> creatives[Creatives]
    dream_adserver --> advertisers[Advertisers]

All queries must be wrapped in the appropriate domain root field.

Common Query Patterns

The ADP API uses consistent patterns across all operations:

  • Filtering - Operator-based: {"field": {"=": value}}
  • Sorting - Lowercase only: {"field": "desc"}
  • Pagination - Offset-based: limit and offset

Your First Query

Here's a complete example showing authentication, filtering, and sorting:

query GetActiveLineitems($filter: JSON, $sort: JSON) {
  dream_adserver {
    lineitems(
      filter: $filter
      sort: $sort
      limit: 5
    ) {
      edges {
        lineitem_id
        lineitem_name
        lineitem_type
        lineitem_status
      }
      total_count
    }
  }
}

Variables:

{
  "filter": {
    "lineitem_is_archived": {"=": false}
  },
  "sort": {
    "lineitem_id": "desc"
  }
}

Interactive Playground

Explore the API interactively at:

https://adp-api.dreamlab.pl/playground

The Playground provides:

  • Schema documentation browser
  • Auto-complete for queries
  • Real-time query validation
  • Example queries and mutations

Next Steps

  1. Authenticate - Set up your credentials and test your first query
  2. Learn GraphQL Structure - Understand the 8 domain root fields
  3. Avoid Common Mistakes - Learn the 4 critical errors to avoid
  4. Explore Delivery APIs - Manage campaigns, line items, and creatives

Need Help?