Documentation

Campaign

The campaign endpoint is for creating and updating a campaign or group.

POST: /api/campaign?advertiser-slug={advertiser-slug}

The advertiser slug must be set in the query params. The other data can be send in the the body:

{
    "name": "test"
}

If successful the API will return a 200 header and the following JSON output:

{
    id: 12345,
    name: 'Name of the campaign',
    parent_id: NULL,
}

GET: /api/campaign/{id}?advertiser-slug={advertiser-slug}

With the get campaign endpoint you can retrieve the campaign data and associated banners.

If succesful the API will return a 200 header and the following JSON output:

    "id": 3613,
    "name": "PAGE_BOTTOM",
    "created_at": "2022-08-19 11:50:43",
    "updated_at": "2022-08-19 11:50:43",
    "banners": [{...}]

POST: /api/banner/connect

To connect a banner to a campaign you can use this endpoint. The /api/banner endpoint will return you a banner id. The /api/campaign will return you a campaign id. You can use both in the body of this endpoint to connect the banner to the campaign.

The advertiser slug must be set in the query params. The other data can be send in the the body:

{
    livetags_id: 12345,
    banner_id: 12345
}

If successful the API will return a 200 header and the following JSON output:

{
    message: "200 OK"
}

Need Pexi now? Contact us!