Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Online Ads

Search Online Ads

Endpoint to search OnlineAds using filtering parameters.

get/business/v2/online-ads

Query parameters

textstring

A simple text to search in the OnlineAds data (name, description, assignee name).

Example:onlinename

A simple text to search in the OnlineAds data (name, description, assignee name).

platformsOnlineAdsPlatform[]

The OnlineAds platform.

The OnlineAds platform.

assigneesstring[]

The OnlineAds assignees.

[
  "776f5018-07e5-426b-a426-8b23fa1e985d"
]
statusesOnlineAdsStatus[]

The Online Ad status.

The Online Ad status.

pinteger

It indicates the specific page to display (the counter starts from zero).

Example:3

It indicates the specific page to display (the counter starts from zero).

sinteger

It indicates the number of items per page.

Example:25

It indicates the number of items per page.

d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC

It indicates how the pages are ordered.

propsstring[]

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

[
  "creationTime"
]

Response

The result is an array containing OnlineAds.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "name": "EXAMPLE ONLINE AD",
      "description": "This is an online advertisement",
      "assignees": [
        "XMPL1234-000001",
        "XMPL1234-000002",
        "XMPL1234-000003"
      ],
      "wallet_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
      "last_spent_date": "2020-05-07T12:48:40Z",
      "last_spent": 75.01,
      "total_spent": 775.01,
      "card_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
      "creation_time": "2017-06-01T12:48:40Z",
      "last_update_time": "2017-06-01T12:48:40Z"
    }
  ]
}