Advertisers

Advertisers are the brands on your platform that would like to purchase OOH.

list advertisers

GEThttps://www.example.com/v1/advertisers

Header parameters

Response

200

successful

Body

application/json

records*array of object

pagination*object

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/advertisers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "records": [
    {
      "name": "text",
      "website": "text"
    }
  ],
  "pagination": {}
}

create advertiser

POSThttps://www.example.com/v1/advertisers

Header parameters

Body

application/json

name*string

website*string

brandnullstring

Response

200

successful

Body

application/json

id*integer

name*string

website*string

brandnullstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/advertisers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "website": "text"
    }),
});
const data = await response.json();

Response

200

{
  "name": "text",
  "website": "text"
}

show advertiser

GEThttps://www.example.com/v1/advertisers/{id}

Path parameters

id*string

Header parameters

Response

200

successful

Body

application/json

id*integer

name*string

website*string

brandnullstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/advertisers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "name": "text",
  "website": "text"
}

update advertiser

PATCHhttps://www.example.com/v1/advertisers/{id}

Path parameters

id*string

Header parameters

Body

application/json

namestring

websitestring

brandnullstring

Response

201

successful

Body

application/json

id*integer

name*string

website*string

brandnullstring

Request

JavaScriptCurlPython

const response = await fetch('https://www.example.com/v1/advertisers/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "name": "text",
  "website": "text"
}

Endpoints

Summary

POST /advertisers #=> Create advertiser
GET /advertisers #=>  List advertisers
GET /advertisers/:id #=> Get specific advertiser
PATCH /advertisers/:id #=> Edit advertiser

Create Advertiser

POST /advertisers

Expects:
- name
- website
- brand (optional)

Returns:
- id
- name
- website

Important note: You should save the returned id to the advertiser on your end – it's needed for other requests.

List Advertisers

GET /advertisers
Returns: paginated array of advertiser objects inside a "records" key

Get Advertiser

GET /advertisers/:id
Returns:
{
  "records": [
    {
      "id": 1,
      "name": "First Advertiser",
      "website": "www.first.com",
      "brand": null
    },
    {
      "id": 2,
      "name": "Second Advertiser",
      "website": "www.second.com",
      "brand": null
    }
  ],
  "pagination": {
    "current_page": 2,
    "next_page": null,
    "prev_page": 1,
    "total_pages": 2,
    "total_entries": 4
  }
}

Edit Advertiser

PATCH /advertisers/:id
Expects: any combination of name, website, and/or brand

Returns:
- id