GET
/
projects
/
{project_id}
/
ads
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/ads \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "type": "custom",
    "enabled": true,
    "placement": "pre-roll",
    "vast_url": null,
    "title": "My first ad",
    "click_through_url": "https://example.com",
    "image_url": "https://example.com/image.png",
    "media_url": "https://example.com/advert.mp3",
    "media": [
      {
        "id": 123,
        "content_type": "audio/mpeg",
        "url": "https://example.com/transcoded.mp3",
        "duration": 15000
      },
      {
        "id": 124,
        "content_type": "application/vnd.apple.mpegurl",
        "url": "https://example.com/transcoded.m3u8",
        "duration": 15000
      }
    ],
    "theme": null,
    "dark_theme": null,
    "light_theme": null,
    "video_theme": null,
    "time_range": {
      "start": "2023-12-01 00:00:00 UTC",
      "end": "2023-12-31 23:59:59 UTC"
    },
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 2,
    "type": "vast",
    "enabled": true,
    "placement": "pre-roll",
    "vast_url": "https://example.com/vast.xml",
    "title": "My second ad",
    "click_through_url": null,
    "media_url": null,
    "media": [],
    "theme": "auto",
    "dark_theme": null,
    "light_theme": null,
    "video_theme": null,
    "time_range": null,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Query Parameters

​
pagination[limit]
integer

'limit' sets the number of results to return in each page.

​
pagination[offset]
integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

​
filter[title]
string

filter by title

Response

200
application/json
OK

The response is of type object[].