Search Mixed Content - Placewise API

Allows to search through different type of content records (e.g. Articles, Events)

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params application/json

mixed_content

object

required

publication_status

enum<string>

optional

When present, only records with specified type are returned

Allowed values:

publishedscheduled

types

array[string]

optional

When present, only records with specified type are returned

Allowed values:

articleeventpromotion

Default:

eventarticlepromotion

page_no

integer

optional

Number of results page. See: API Pagination

Default:

per_page

integer

optional

Number of results to be returned per request. See: API Pagination

Default:

100

sort_by

array[string]

optional

See: Sorting params

Allowed value:

visible_since

sort_directions

array[string]

optional

See: Sorting params

Allowed values:

ASCDESC

string

optional

When present, only records with pharse in headline, title

references

array [object {2}]

optional

When present, only records matching given type + id pair are returned

tag_ids

array

optional

When present, only records with one of specified tags are returned

Example

{
  "mixed_content": {
    "publication_status": "published",
    "types": [
      "event",
      "article"
    ],
    "page_no": 2,
    "per_page": 10,
    "sort_by": [
      "visible_since"
    ],
    "sort_directions": [
      "DESC"
    ],
    "tag_ids": [
      1,
      2,
      3
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

items

array [object {12}]

required

Fields that are common for all types are listed here. Response includes also type-specific fields like "author" for articles

integer <uint64>

read-onlyrequired

Example:

type

enum<string>

required

Allowed values:

articleeventpromotion

customer_id

integer <uint64>

read-onlyrequired

Customer the record is assigned to

Example:

447

title

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

headline

object (LocalizedContent) | null

required

Example:

{"en":"Text"}

visible_since

required

visible_until

required

created_at

string <date-time>

read-onlyrequired

Time of record creation

Example:

2022-11-05T16:25:58.099512Z

updated_at

string <date-time>

read-onlyrequired

Time of the last record update

Example:

2022-11-15T16:25:58.099512Z

image

required

publication_status

enum<string>

read-onlyrequired

Visibility status of the record in CMS Public API that takes into the consideration status, visible_since and visible_until dates

Allowed values:

publisheddraftexpiredscheduled

Example:

published

url

string

required

Address of the entity page on website

Example:

path/to/:id

pagination_info

object (PaginationInfo) | null

read-onlyrequired

count

integer

read-onlyrequired

Actual number of results returned in request

Example:

1000

total_count

integer

required

Number of all available results

>= 1

Example:

2050

per_page

integer

read-onlyrequired

Number of results returned per request

Example:

1000

total_pages

integer

read-onlyrequired

Number of all available pages

Example:

current_page

integer

read-onlyrequired

Example:

next_page

integer | null

read-onlyrequired

Next available page (null when it's a last page)

Example:

prev_page

integer | null

read-onlyrequired

Next available page (null when it's a first page)

Example:

null

is_first_page

boolean

read-onlyrequired

Example:

true

is_last_page

boolean

read-onlyrequired

Example:

false

is_out_of_range

boolean

read-onlyrequired

Is given per_page param out of range?

Example:

false

offset

integer

read-onlyrequired

Example:

Example

{
  "items": [
    {
      "id": 1,
      "type": "article",
      "customer_id": 447,
      "title": {
        "en": "Text"
      },
      "headline": {
        "en": "Text"
      },
      "visible_since": "2022-11-09T16:25:58.099512Z",
      "visible_until": "2022-11-15T16:25:58.099512Z",
      "created_at": "2022-11-05T16:25:58.099512Z",
      "updated_at": "2022-11-15T16:25:58.099512Z",
      "image": {
        "url": "https://example.com/image.png",
        "identifier": "1",
        "mime_type": "image/jpeg",
        "created_at": "2022-11-09T15:46:00.252860Z",
        "updated_at": "2022-11-09T15:46:00.252860Z",
        "image_details": {
          "width": 1,
          "height": 1
        }
      },
      "publication_status": "published",
      "url": "path/to/:id"
    }
  ],
  "pagination_info": {
    "count": 1000,
    "total_count": 2050,
    "per_page": 1000,
    "total_pages": 3,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null,
    "is_first_page": true,
    "is_last_page": false,
    "is_out_of_range": false,
    "offset": 0
  }
}