canonical: https://jentic.com/apis/optmyzr.com/optmyzr

# Optmyzr API

Jentic publishes the only available OpenAPI specification for Optmyzr API, keeping it validated and agent-ready. Optmyzr is a PPC management platform that surfaces optimisation suggestions, performance metrics, and workout-style task lists for paid-search advertisers managing Google Ads, Microsoft Ads, and Amazon Ads accounts. The User Data API provides read-only access to optimisation suggestions, history, active alerts, account metrics, and blueprint tasks. Authentication is an API token passed as a query parameter on every call.

## For AI agents

Read Optmyzr PPC optimisation suggestions, history, alerts, metrics, and blueprint tasks across 9 endpoints, with API-token query authentication.

## Scope

Does not handle pushing changes to Google Ads, account billing, or workout configuration writes - use for read-only Optmyzr suggestion, alert, metric, and task retrieval only.

## Capabilities

- List the Google Ads, Microsoft Ads, and Amazon Ads accounts visible to the calling token
- Retrieve current optimisation suggestions Optmyzr has surfaced for an account
- Pull optimisation history showing which suggestions were applied or dismissed
- Read active alerts indicating issues requiring PPC manager attention
- Fetch performance metrics (cost, clicks, conversions) for managed accounts
- Look up workout history and the list of custom workouts configured per account

## Use cases

### PPC manager weekly review

Account managers running weekly reviews can pull a unified view across the agency's book by chaining GET `/UserData/V1/Accounts` to enumerate accounts and GET `/UserData/V1/OptimizationSuggestions` per account. The agent assembles a single weekly report rather than logging into each account through the Optmyzr UI.

Example prompt: GET `/UserData/V1/Accounts`, then for each account_id GET `/UserData/V1/OptimizationSuggestions` and compile a markdown report grouped by account.

### Alert-driven on-call rotations

Agencies can wire Optmyzr alerts into on-call rotations by polling GET `/UserData/V1/ActiveAlerts` on a schedule and routing matched alerts to the responsible PPC analyst through chat or ticketing. Because the endpoint returns alerts already filtered to the calling token, every analyst sees only their share of the book.

Example prompt: GET `/UserData/V1/ActiveAlerts` every 15 minutes, then post any new alerts to the PPC team's incident channel with the linked account ID.

### Performance metrics export

Agencies feeding their own data warehouse can call GET `/UserData/V1/Metrics` on a daily schedule to extract cost, clicks, and conversion data for every account, then load the response into BigQuery or Snowflake for client reporting. Because the endpoint is read-only, agents can retry safely on transient failures.

Example prompt: GET `/UserData/V1/Metrics` with a date range covering yesterday and stage the response in the warehouse landing zone.

### AI agent for PPC operations

Through Jentic, a PPC operations agent can answer 'what needs doing today' by calling GET `/UserData/V1/ActiveAlerts` and GET `/UserData/V1/OptimizationSuggestions`, summarising the highest-impact items in plain language. The Optmyzr token sits in your Jentic One instance, so analysts can use the agent without holding the credential.

Example prompt: Search Jentic for 'get optmyzr active alerts', execute `/UserData/V1/ActiveAlerts`, and surface the top three by impact.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/UserData/V1/Accounts` | List managed PPC accounts |
| GET | `/UserData/V1/OptimizationSuggestions` | Get current optimisation suggestions |
| GET | `/UserData/V1/OptimizationHistory` | Get optimisation history |
| GET | `/UserData/V1/ActiveAlerts` | Get active alerts |
| GET | `/UserData/V1/Metrics` | Get account metrics |
| GET | `/UserData/V1/Workouts` | Get custom workouts |
| GET | `/UserData/V1/BlueprintTasks` | Get blueprint tasks |

## Key resources

- **Accounts** — PPC accounts visible to the calling token
- **Optimization Suggestions** — Current PPC optimisation recommendations
- **Optimization History** — Record of suggestions accepted or dismissed
- **Active Alerts** — Alerts requiring manager attention
- **Metrics** — Cost, clicks, and conversion metrics for accounts
- **Workouts** — Custom workouts configured in the Optmyzr workspace
- **Blueprint Tasks** — Tasks generated from Optmyzr blueprints

## Why Jentic

- **Setup:** Wiring the Optmyzr API by hand means appending its token as a query parameter on every call and mapping the UserData suggestion, alert, metric, and task routes yourself. Through Jentic you install once, import the Optmyzr API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Optmyzr requests carry their target as query parameters rather than a resource id in the path, and the surface is read-only, so scoping is by operation: you limit the agent to the operations it needs, such as reading active alerts or listing accounts, and leave the others out unless you want them. Every operation the agent can call is one you chose to allow.
- **Credential handling:** Your Optmyzr token is stored once, encrypted, by your own Jentic One instance and appended to the request at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get optmyzr active alerts' or 'list optmyzr accounts', and Jentic returns the matching operation under `/UserData/V1`/ with its parameter schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Opteo** — Google Ads optimisation platform with improvement suggestions and performance goals
- **WhatConverts** — Lead-tracking platform tying paid clicks to qualified outcomes
- **Mixpanel** — Product analytics platform used to validate paid-search conversion impact

## FAQ

### Why is there no official OpenAPI spec for Optmyzr API?

Optmyzr does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Optmyzr API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Optmyzr API use?

The Optmyzr User Data API uses an API token sent as the 'token' query parameter. Through Jentic the token is stored encrypted in the vault and added to the URL at execution, so an agent never holds or constructs the URL itself.

### Can I push changes to PPC accounts through this API?

No. This API is read-only - every endpoint is GET. Suggestions are surfaced for review but the User Data API does not provide write paths into Google Ads or Microsoft Ads. Acting on suggestions happens through the Optmyzr UI or Optmyzr's separate write-capable surfaces.

### What are the rate limits for the Optmyzr API?

Optmyzr does not document fixed rate limits in this spec; they are governed by your Optmyzr commercial plan. Treat 429 responses as a signal to back off and confirm ceilings with the Optmyzr account team before scheduling frequent metric pulls.

### How do I get current optimisation suggestions through Jentic?

Search Jentic for 'get optmyzr optimisation suggestions', load GET `/UserData/V1/OptimizationSuggestions`, and execute it. The vaulted token is supplied automatically as the query parameter.

### What data does the metrics endpoint return?

GET `/UserData/V1/Metrics` returns aggregated PPC metrics - cost, clicks, conversions, and similar fields - for the accounts visible to the calling token across the requested date range. Granularity and exact field names follow the Optmyzr documentation for User Data.

### Can I limit what my agent is allowed to do with the Optmyzr API?

Yes. Because you run Jentic One yourself, your own rules decide which Optmyzr operations and credentials the agent may use, and this API is read-only, so scoping is by operation. You can allow just the operations the agent needs, such as GET `/UserData/V1/ActiveAlerts` to read alerts or GET `/UserData/V1/Accounts` to list accounts, and leave the others out, keeping optimisation suggestions, metrics, and blueprint task retrieval off the table unless you choose to allow them. Every operation the agent can call is one you decided to permit.