Quick start

This takes about five minutes. You need Partner API access for your organization (see the introduction) and a dashboard login.

1. Create a token#

1. Sign in to the dashboard and open Organization > API tokens.
2. Create a token with:
   • a label that says where it will run, such as revenue-sync;
   • the reporting:read scope;
   • the default expiry of one year.
3. Copy the token. You see it only once.

2. Store the token#

Keep the token on your server, in a secrets manager or an environment variable. Never put it in code that runs in a browser.

export INLINE_API_TOKEN="inl_live_abcd1234_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

This value is a placeholder that shows the shape of a token. See token format.

3. Check the token#

GET /v1/ping works with any valid token. It returns your organization and the token's scopes.

curl "https://partner-api.getinline.tech/v1/ping" \
  -H "Authorization: Bearer $INLINE_API_TOKEN"

{
  "data": {
    "organization": {
      "id": "00000000-0000-4000-8000-000000000002",
      "name": "Example Media"
    },
    "token": {
      "key_id": "abcd1234",
      "scopes": ["reporting:read"],
      "expires_at": "2027-10-24T00:00:00Z"
    }
  }
}

• token.key_id matches the key ID in the dashboard. It is safe to log.
• token.expires_at is when the token stops working, or null if it never expires.

A 401 means the token is missing, mistyped, revoked, expired, or for another environment.

4. Pull a revenue report#

Ask for one week of revenue. Dates are UTC, and both ends are included.

curl "https://partner-api.getinline.tech/v1/reports/revenue?start_date=2026-10-01&end_date=2026-10-07" \
  -H "Authorization: Bearer $INLINE_API_TOKEN"

{
  "data": [
    {
      "date": "2026-10-01",
      "publisher_id": "00000000-0000-4000-8000-000000000001",
      "primary_domain": "example.com",
      "gross_revenue": 20.57613,
      "net_revenue": 12.345678,
      "impressions": 4210,
      "currency": "USD",
      "is_final": true
    }
  ],
  "meta": {
    "next_cursor": null,
    "data_through": "2026-10-07"
  }
}

You get one row for each publisher and day. The other six rows are left out above.

• gross_revenue is what ad partners paid.
• net_revenue is your share of it.
• primary_domain is the publisher's main domain, so you can match rows to your sites without storing Inline IDs.
• is_final: true means ad partners will not revise that date. See when numbers change.
• meta.next_cursor is null on the last page. Otherwise, send it as cursor to get the next page.

Next steps#