Numia Docs

Get Campaign

Get Campaign Guide

This guide explains how to request an ad using the NumiaEngage API, including the required parameters and a sample response.

Request an Ad

To request an ad, use the following cURL command:

curl -X GET "https://api.staging.numia.xyz/campaign/:address?position_id=:position_id" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer :bearer_token"

Parameters

  • address (Path Parameter):

    • The blockchain address of the connected wallet.
    • For non-wallet-specific ads, pass address=global.

  • position_id (Query Parameter): The unique identifier for the ad placement, such as wallet_home.

  • bearer_token (Header): The authentication token required to authorize the request.

Example response

The API returns a JSON object containing the details of the requested ad. Below is an example response:

[
  {
    "campaign_id": 1,
    "campaign_owner": "Quasar",
    "campaign_name": "01 - Quasar CL Campaign",
    "campaign_topic": "Concentrated Liquidity",
    "audience_id": 1,
    "audience_name": "Osmosis - OOB & don't manage positions",
    "address": "osmo1k2a9heyxv95xl9j88dz90ge4qs6qq9hun7qgy8",
    "creatives": {
      "position_id": "wallet_home",
      "logo": "https://storage.googleapis.com/numia-campaigns/campaign-assets/1-quasar-cl/quasar-logo.png",
      "title": "No time to manage positions?",
      "body": "Optimize returns with our managed vaults!",
      "cta": "Dive deeper",
      "link": "https://app.quasar.fi"
    }
  }
]