Nozzle documentation

API

Authenticate with the Nozzle API and pull ranking data programmatically.

API

Product guide

API

Authenticate with the Nozzle API and pull ranking data programmatically.

View category
  1. Admin APIA quickstart for the Nozzle Admin API, covering API tokens, workspace and project ids, template tokens, and a cURL example for listing your projects.
  2. How do I authenticate with the Nozzle API?How to authenticate with the Nozzle API using a long-lived key in the Authorization header, plus finding the workspace, team, and keyword source IDs.
  3. How Do I Create An API Token?How to create a Nozzle API token from the Users page, save it the one time it is shown, and send it in the Authorization header with the Token prefix.
  4. How do I export my Nozzle data?An overview of the ways to get data out of Nozzle, from one-off CSV downloads to live BigQuery access, and which to pick for what you're doing.
  5. How do I use the Copy cURL feature to pull data via the API?Every Performance dashboard widget can hand you the exact API call that powers it. Here's how to use it.
  6. How do keyword sources work?How keyword sources work in Nozzle: the phrases, locales, devices, and schedules they bundle, plus how to read and update them safely via the API.
  7. How do Nozzle locales work?A Nozzle locale is one ID combining country, city, language, and device. How to find the localeId you need and request missing combinations.
  8. Reporting APIA quickstart for the Nozzle Reporting API, with an example groupByOverTime curl call, template tokens to swap out, and the available metrics.
  9. What do common API errors mean?A reference for HTTP status codes you might encounter when calling the Nozzle API, and how to fix them.