Ad TaggingApprove or disable automatic checks

Approve or disable automatic checks

enabled: true approves automatic checks. Set auto_interval_minutes with PUT /meta. The default is 15 minutes. It must be an integer from 5 to 1440 in steps of 5. Cron checks due configs every five minutes, oldest due first, with up to 10 configs per tick and a time budget. Busy, skipped and failed checks consume capacity too. Large rosters and cooldowns can stretch the interval.

No-op or failed scans do not create runs. Auto runs journal only set ads. Skips are counted in ads_skipped but have no auto change rows. The read-only config fields last_auto_at, last_auto_status and last_auto_error report the last check. A queued check is not proof that writes succeeded. Auto runs have a run_slot timestamp. It replaces run_date. The old last_auto_date field is removed.

Approval requires a complete (not truncated), published, unexpired preview matching the saved config's generation, revision and fingerprint, and acknowledge_creative_swap: true. A reconnect cannot reuse an old preview. Fingerprint changes revoke approval. An interval-only edit preserves revision, previews, runs and approval. Automatic checks skip ads whose links Mythic cannot inspect (link_unverified) and uses the same fresh eligibility and full copy verification as manual apply.

Approval can be saved while writes_enabled is false. In that case auto_enabled: true means approval is pending global activation. No ads change until live Meta writes are switched on.

enabled: false works on every plan and cancels a queued or running auto run.

curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/ad-tagging/meta/auto?location_id=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "enabled": true,
  "preview_id": "123e4567-e89b-12d3-a456-426614174000",
  "acknowledge_creative_swap": true
}'
{
  "success": true,
  "data": {
    "ad_account_id": "example_string",
    "enabled": true,
    "short_links": true,
    "resolve_names": true,
    "utm_template": "example_string",
    "overwrite": "fill_missing",
    "ad_statuses": [
      "ACTIVE"
    ],
    "rules": {
      "version": 42,
      "operator": "AND",
      "conditions": [
        {
          "type": "campaign_name_contains",
          "value": "example_string",
          "case_sensitive": true
        }
      ]
    },
    "credential_name": "John Doe",
    "auto_interval_minutes": 42,
    "last_auto_at": "2024-12-25T10:00:00Z",
    "last_auto_status": "example_string",
    "last_auto_error": "example_string",
    "generation": "123e4567-e89b-12d3-a456-426614174000",
    "revision": 42,
    "fingerprint": "example_string",
    "auto_enabled": true,
    "auto_approved_fingerprint": "example_string",
    "auto_approved_preview_id": "example_string",
    "auto_approved_by": "example_string",
    "auto_approved_at": "2024-12-25T10:00:00Z",
    "throttled_until": "2024-12-25T10:00:00Z",
    "last_run_at": "2024-12-25T10:00:00Z",
    "last_run_status": "example_string",
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  },
  "cancelled_runs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "writes_enabled": true
}
POST
/client/v1/ad-tagging/meta/auto
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) or location secret key (sk_, reads of the config and runs only). Scoped keys (mcp_) are accepted too and need ad_tagging:read or ad_tagging:write. See Using an mcp_ key over HTTP.

Agency key (ak_) or location secret key (sk_, reads of the config and runs only). Scoped keys (mcp_) are accepted too and need ad_tagging:read or ad_tagging:write. See Using an mcp_ key over HTTP.
query
location_idstring

Location to scope to. Required for ak_ keys or send X-Location-Id. Ignored for sk_.

Content-Typestring
Required

The media type of the request body

Options: application/json
preview_idstring

Required when enabling.

Format: uuid
acknowledge_creative_swapboolean

Required when enabling.

Options: true
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) or location secret key (sk_, reads of the config and runs only). Scoped keys (mcp_) are accepted too and need ad_tagging:read or ad_tagging:write. See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Location to scope to. Required for ak_ keys or send X-Location-Id. Ignored for sk_.

Body

application/json
preview_idstring

Required when enabling.

acknowledge_creative_swapboolean

Required when enabling.

Allowed values:true

Responses

successboolean
dataobject
cancelled_runsstring[]
writes_enabledboolean