API Status
Services
Several API endpoints (deals, advertisers, transactions, status changes, contacts, domain search) use Search (Elasticsearch/OpenSearch) for fast queries. If Search is unavailable, those endpoints may return 503 or empty results.
| Service | Status | Used by |
|---|---|---|
| Search (Elasticsearch/OpenSearch) | Available | Deals, Advertisers, Transactions, Status changes, Contacts, Domain search |
All API endpoints
Every API endpoint with a link to its full documentation. Signed-in users can run live GET checks (same pattern as publisher credential validation) to confirm each route responds. Sign in to enable live testing with your API key.
| Method | Path | Description | Live check | Documentation |
|---|---|---|---|---|
| POST | /mcp |
Model Context Protocol server for tool and resource access across the existing API | Skipped | |
| GET | /api/v1/tools |
List available tools for AI agents | Sign in required | |
| GET | /api/v1/search |
Universal Searchkick omnibox across advertisers, publishers, agencies, deals, contacts, and (admin) users | Sign in required | |
| GET | /api/v1/schema |
OpenAPI-style schema | Sign in required | |
| GET | /api/v1/deals |
List and filter deals | Sign in required | |
| GET | /api/v1/deals/:id |
Get a single deal | Sign in required | |
| GET | /api/v1/advertisers |
List and search advertisers | Sign in required | |
| GET | /api/v1/advertisers/search_by_domain |
Search advertisers by domain | Sign in required | |
| GET | /api/v1/advertisers/:id |
Get a single advertiser | Sign in required | |
| GET | /api/v1/advertisers/:id/similar_advertisers |
List similar advertisers | Sign in required | |
| GET | /api/v1/advertisers/:id/related_advertisers |
List related advertisers | Sign in required | |
| GET | /api/v1/opportunities |
List opportunity advertisers | Sign in required | |
| GET | /api/v1/contacts |
Search contacts | Sign in required | |
| POST | /api/v1/contacts |
Create a contact (admin) | Skipped | |
| GET | /api/v1/transactions |
List and filter transactions | Sign in required | |
| GET | /api/v1/transactions/:id |
Get a single transaction | Sign in required | |
| GET | /api/v1/clicks |
Retrieve clicks for a date range up to 90 days | Sign in required | |
| POST | /api/v1/graphql |
Read-only GraphQL over the core REST resources | Skipped | |
| GET | /api/v1/domains/search |
Search advertisers by domain | Sign in required | |
| GET | /api/v1/verticals |
List verticals (categories) | Sign in required | |
| GET | /api/v1/tags |
Search tags (categories) | Sign in required | |
| GET | /api/v1/tags/:id/advertisers |
List advertisers for a tag (category) | Sign in required | |
| POST | /api/v1/publishers |
Create a publisher (admin) | Skipped | |
| GET | /api/v1/publishers/:id |
Get publisher and network keys | Sign in required | |
| PATCH | /api/v1/publishers/:id |
Update publisher/network credentials | Skipped | |
| GET | /api/v1/users |
Search users in your accessible scope | Sign in required | |
| POST | /api/v1/users |
Create a user in account scope | Skipped | |
| GET | /api/v1/reports |
List report aliases and raw materialized-view reports | Sign in required | |
| GET | /api/v1/reports/:id |
Fetch a report as JSON by alias or materialized-view name | Sign in required | |
| GET | /api/v1/agencies |
List agencies | Sign in required | |
| GET | /api/v1/agencies/:id |
Get a single agency | Sign in required | |
| GET | /api/v1/networks |
List networks | Sign in required | |
| GET | /api/v1/networks/:id |
Get a single network | Sign in required | |
| GET | /api/v1/status_changes |
List status changes | Sign in required | |
| POST | /api/v1/deeplinks/generate |
Generate affiliate tracking link for a URL | Skipped | |
| GET | /api/search/autocomplete |
Global autocomplete (advertisers, deals, tags, etc.) | Sign in required |
API Playground
Run sample calls for health and discovery endpoints. Click Test to run and preview JSON, or Open to open the endpoint in a new tab. Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| MCP reachability (GET) | GET |
/mcp |
Authenticated MCP bootstrap JSON (protocol version, integration URL, OAuth hints). |
| MCP integration JSON | GET |
/mcp/integration |
ChatGPT / Claude / Responses API wiring metadata. |
| Initialize MCP | POST |
/mcp |
Start an MCP JSON-RPC session for tools and resources. |
| List API tools | GET |
/api/v1/tools |
Machine-readable endpoint index for AI agents. |
| Fetch API schema | GET |
/api/v1/schema |
OpenAPI-style schema payload for integration. |
| Quick deals probe | GET |
/api/v1/deals?limit=3 |
Verify the deals endpoint responds. |
| Universal search | GET |
/api/v1/search?q=sample |
One-shot discovery across advertisers, deals, contacts, and related types. |
GET /mcp
MCP
GET /mcp returns the same authenticated setup payload remote MCP clients use for health checks.
GET /mcp/integration.json
MCP
Download integration JSON for marketplace connectors.
POST /mcp — initialize
MCP
JSON-RPC initialize to negotiate protocolVersion 2025-11-25.
GET /api/v1/tools
v1
Discover available API tools.
GET /api/v1/schema
v1
Fetch API schema.
GET /api/v1/deals?limit=3
v1
Quick response check.
GET /api/v1/search?q=energy&per_type_limit=3
v1
Universal search with a low per-type cap for fast smoke tests.