Skip to main content

Opteo API

Read and update your Opteo data from your own code with the Opteo API, available on request.

The Opteo API lets you read and update your Opteo data from your own code. It's available on request: message us from the chat bubble in Opteo to ask for an API key. The same key works in Zapier.

The base URL is https://api.opteo.dev/v0. Full documentation, with examples, is at github.com/Opteo/api.

Authentication

Send your key as a bearer token on every request, over HTTPS:

Authorization: Bearer {YOUR_KEY}

The key gives access to every ad account in your Opteo team.

What you can do

  • Customers: list your ad accounts (linked, unlinked or all), see who's connected to each, and set the changelog email.

  • Budget: get or set an ad account's monthly budget in Opteo.

  • Performance mode: get or switch between CPA and ROAS.

  • Performance goals: get or update an ad account's Performance Goals.

  • Improvements: get an ad account's active and completed Improvements.

  • Alerts: get alerts for one ad account or all of them.

  • Reports: list your reports and download them as PDFs.

  • GAQL: run Google Ads Query Language queries (Google Ads only).

  • Run Agent: ask Agent about an ad account and get the answer sent to your callback URL.

Endpoints for a single ad account use its ID from the ad platform in the URL. Get the IDs from the Customers endpoint.

Errors

The API uses standard HTTP status codes. A 403 usually means the ad account isn't linked in Opteo, or there's a problem with your subscription.

Did this answer your question?