Sign in
Ad Campaigns

Get ad details

Returns an ad with its creative, targeting, status, and performance metrics.

The {adId} path segment accepts any identifier dialect Zernio indexes for the ad:

  • the Zernio internal _id (24-char hex)
  • Meta's numeric platformAdId (the value shipped in comment.received webhooks as comment.ad.id)
  • the creative's effective_object_story_id ({pageId}_{postId} shape, Facebook side)
  • the creative's effective_instagram_media_id (Instagram side)

Any of the four resolve to the same ad. Caller doesn't need a translation step.

get/v1/ads/{adId}

Path parameters

adIdstring required

Zernio _id (hex), Meta platformAdId (numeric), or one of the creative's effective story/media IDs. See description for details.

Response

Ad details

Example response

{
  "ad": {
    "configuredStatus": "ACTIVE",
    "creativeType": "video",
    "metrics": {
      "actions": {
        "link_click": 160,
        "post_engagement": 300,
        "offsite_conversion.fb_pixel_purchase": 42
      },
      "actionValues": {
        "offsite_conversion.fb_pixel_purchase": 2456.78,
        "offsite_conversion.fb_pixel_add_to_cart": 980.5
      },
      "costPerAction": {
        "link_click": 0.1052,
        "offsite_conversion.fb_pixel_purchase": 4.0114
      }
    },
    "platformObjective": "OUTCOME_SALES",
    "optimizationGoal": "OFFSITE_CONVERSIONS",
    "costType": "CPC",
    "servingStatuses": [
      "ACCOUNT_TOTAL_BUDGET_HOLD"
    ],
    "platformAdAccountName": "Zernio - previously Late",
    "bidAmount": 5,
    "roasAverageFloor": 2,
    "promotedObject": {
      "custom_event_type": "PURCHASE"
    },
    "creative": {
      "servingHoldReasons": [
        "UNDER_REVIEW"
      ]
    }
  }
}

Changes

Changed in 3 of the 27 revisions of this API.18

  • 44b6b1ca2a8b1See the full diff
    • ●

      added the new page_likes enum value to the ad/goal response property for the response status 200

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a23bb6e634381See the full diff
    • ○

      added the optional property ad/creative/creativeId to the response with the 200 status

      response-optional-property-added

  • 5bcceb4c15ba7See the full diff
    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/costPerAction to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/inlineLinkClickCtr to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/inlineLinkClicks to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/outboundClicks to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/outboundClicksCtr to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/uniqueClicks to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property ad/metrics/anyOf[AdMetrics]/uniqueCtr to the response with the 200 status

      response-optional-property-added