MAmagellan
Campaigns

Create a new campaign

Changed on

Generates unique identifier for a campaign in Magellan AI. Campaigns link the pixel on the advertiser's site with ad exposures.

post/measurement/campaigns

Request

  • Base URL
    https://api.magellan.ai/v2
  • URL
    https://api.magellan.ai/v2/measurement/campaigns
  • Auth
    API key in header Authorization

Request body

Example request

{
  "measurementCampaign": {
    "pixelId": "0123456789abcdef",
    "name": "Brand Campaign Q2",
    "startDate": "2024-03-01",
    "endDate": "2024-03-01"
  }
}

Response

OK

Example response

{
  "measurementCampaign": {
    "id": "0123456789abcdef",
    "name": "Brand Campaign Q2",
    "startDate": "2024-03-01",
    "endDate": "2024-03-01",
    "customEvents": [
      {
        "id": 1,
        "label": "Signup",
        "pattern": "example.com/sign_up"
      }
    ],
    "pixel": {
      "id": "0123456789abcdef",
      "name": "Attribution Pixel",
      "brand": {
        "crmBrandId": "brand_0123456789abcdef",
        "name": "ACME Corp., Inc.",
        "domain": "acme.com"
      }
    },
    "ads": [
      {
        "id": "0123456789abcdef",
        "name": "The Pod Show - Mid-Roll",
        "uid": "ad-123-456",
        "podcast": {
          "id": 1,
          "title": "The Pod Show"
        },
        "cohorts": [
          {
            "cohortName": "Creative",
            "subCohortName": "Holiday 30s"
          }
        ]
      }
    ]
  }
}

Changes

  • beceb462c707Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status