PeekPanda markpeekpandaDocumentation
For your AI
Copy pageCopy entire docs
Dashboard

Get paid-ad analysis

Read where one ad’s creative analysis stands, and the analysis once it is ready.

Download Markdown ↓

GEThttps://api.peekpanda.com/v1/paid-ads/{platform}/{archiveId}/analysis

Request

This read never starts an analysis. status is not_requested when nobody has asked, pending while the worker runs it, ready with the persisted analysis and its generation-time provenance, or failed with failedAt when the last run produced nothing; ask again with POST to retry. Treat creative observations as analysis, not a performance or policy claim.

Parameters

NameInTypeRequiredDescription
platformpathmeta | tiktokYesAdvertising platform.
archiveIdpathstring, 1–255YesProvider archive id.

Response

Returns the analysis state.

Response fields

statusstring
analysis.summarystring
analysis.visibleText[]string[]
analysis.hookNotes[]string[]
analysis.timestampNotes[].timestampSecondsnumber
analysis.timestampNotes[].notestring
analysis.timelineobject
analysis.editingPatternstring
analysis.reusablePromptIngredients[]string[]
analysis.modelstring
analysis.generatedAtstring

Authentication

Requires Bearer API credential or OAuth access token. Scope context:read. MCP calls get_ads with action analysis.

Errors

400invalid_request for an invalid filter, identity or limit.
401authentication_required for a missing or invalid credential.
402subscription_required when access is not entitled.
403authorization_required for a missing scope or unavailable preview access.
403workspace_not_accessible when x-genviral-tenancy names a workspace the credential cannot reach.
404not_found when the record is outside the accessible catalogue.
429rate_limited; honor Retry-After when present.
429daily_call_limit; the plan's daily API and MCP calls are used until 00:00 UTC.

MCP request

Call get_ads with action analysis. Path fields go in params, filters in query, and a write body in body.

{
  "name": "get_ads",
  "arguments": {
    "request": {
      "action": "analysis",
      "params": {
        "platform": "<platform>",
        "archiveId": "<archiveId>"
      }
    }
  }
}

Source

Stored public advertising-library observations with source dates. Spend is unavailable unless the public record reports it.

Refresh

This read returns the stored state and does not begin analysis.

AI agent or LLM? Read this page as markdown