Quickstart

Choose the API that matches your Nexus account and use the host assigned to that customer.

1. Identify the customer domain

If the Nexus panel is https://example.com, use:

• https://api.example.com for Search, XML, Exchange Stats, and Demand Stats.
• https://example.com/api/v1 for Advertiser member operations.
• https://mcp.example.com/mcp for MCP.

2. Obtain the correct credential

• Search, XML, and the current MCP server use a scoped Nexus publisher API key.
• Exchange and Demand Stats use a member API key with rtb:exchange:read or rtb:demand:read, plus the existing resource assignment. See Exchange Stats and Demand Stats.
• Advertiser endpoints use the authenticated member JWT or the secure same-origin session cookie.
• OpenRTB credentials and bidder endpoints are exchanged during partner onboarding.

3. Make a small read-only request

Start with a one-day report. Confirm ownership, date handling, response shape, and timezone before requesting a larger range.

curl --get "https://api.example.com/publisher/search-report" \
  --header "Authorization: Bearer YOUR_NEXUS_API_KEY" \
  --data-urlencode "date_from=2026-08-17" \
  --data-urlencode "date_to=2026-08-17"

4. Handle failures explicitly

Treat 401, 403, 421, 422, 429, and 5xx as distinct conditions. Do not retry authentication or validation failures in a loop.

Reports are limited to 100,000 rows. HTTP 413 means the report is too large: split the requested dates into smaller ranges rather than retrying the same request. Results are never silently truncated. HTTP 503 means a required database or report capacity is temporarily unavailable; retry with bounded exponential backoff. There can be up to 20 concurrent report queries per API process. Real API responses are not cached.

Ask analytics

Use Ask analytics in the bottom-right corner to build a chart directly in this documentation. When enabled by your platform administrator, connect your Nexus API key and ask in English or Bulgarian, for example:

• “Show daily revenue for the last 7 days.”
• “Compare clicks with the previous week.”
• “Покажи приходите по линкове за последните 7 дни.”

The assistant supports Search and publisher XML reporting according to your API key permissions. XML questions can filter by an owned TID or include all owned TIDs when none is selected. Reports show the source and inclusive UTC dates, with up to 90 days per period. Use View data & export for the values and CSV download. Revenue retains the source report's native units.

The API key and conversation stay in this tab's memory; Clear & disconnect or reloading removes them. Questions and previous report parameters are sent to the AI provider to interpret the request; reporting rows and the Nexus API key stay within this API. Keep credentials out of your questions.

Response envelope

Nexus REST endpoints normally return:

{
  "status": "success",
  "message": "Human-readable result",
  "data": []
}

Error responses normally use the same status and message fields without sensitive internal details.