Get template ad details

Returns the click-to-WhatsApp ad campaigns linked to a specific template, including ad ids, spend, and status where available.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdIdentifier of the WhatsApp app the call acts on.6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired
templateIdIdentifier of the message template.tpl-1002StringRequired

Sample cURL — Get template ad details.

curl --request GET \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/template-analytics/templates/tpl-1002/ads' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json'

Sample success response (200)

{
  "status": "success",
  "data": {
    "template_ad_details": {
      "ad_account_id": "3242596802542159",
      "ad_adset_id": "120215865443300592",
      "ad_campaign_id": "120215865319530592",
      "ad_id": "120215865446460592",
      "category": "MARKETING",
      "id": "939035207269681"
    }
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the WhatsApp app the call acts on.

string
required

Identifier of the message template.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json