Placewise API

Query (records)

Designing

POST

https://api.mpc.dev.placewise.com/v1/reporting/query

API Permit:Reporting:Api:Query

API Context:Customer

Authorizations:UserToken

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-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

report

string

required

filter

string

optional

aggregate_by

string

optional

page_info

string

optional

limit

string

optional

Example

{
  "report": "members_grouped_count"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/reporting/query' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "report": "members_grouped_count"
}'

Responses

🟢200Success

application/json

Body

records

array [object {5}]

required

loyalty_club_id

integer

optional

grouping_type

string

optional

grouping_value

string

optional

members_count

integer

optional

updated_at

string

optional

pagination

object | null

required

next_page_info

string

required

Example

{
  "records": [
    {
      "loyalty_club_id": 235,
      "grouping_type": "optin_channel",
      "grouping_value": "default",
      "members_count": 156,
      "updated_at": "2024-07-02T10:33:23.288000Z"
    }
  ],
  "pagination": {
    "next_page_info": "COyB5QM"
  }
}

Modified at 2024-07-31 21:26:55

Field metadata

Query (timeseries)