Skip to content

OpenAPI reference

Nexus publishes three OpenAPI specifications dynamically from every configured API domain. The links below automatically use the current customer hostname.

Search API

Open or download the Search OpenAPI JSON

Documents /publisher/search-report and /publisher/search-links.

XML API

Open or download the XML OpenAPI JSON

Documents the XML statistics endpoint and its supported grouping modes.

Advertiser API

Open or download the Advertiser OpenAPI JSON

Documents the existing member backend for advertiser statistics and owned campaign operations.

Dynamic server addresses

The specifications are generated from the current trusted host. The Advertiser specification points its server URL to the corresponding tenant backend, for example https://example.com/api/v1.

Use a specification

  1. Open one of the JSON links above.
  2. Save it as a .json file or copy its public URL.
  3. Import it into an OpenAPI-compatible client such as Postman, Insomnia, Bruno, or your code generator.
  4. Keep production credentials in the client's protected environment or secret store.

Interactive requests

Browser-based API explorers must run from a trusted CORS origin configured for the platform. Never place a real API key in a public shared workspace.

White-label Nexus API documentation