List Footfall Reports

Pending

GET

https://api.mpc.dev.placewise.com/v1/operations/footfall_reporting/reports

API Permit:Operations:Api:FootfallReporting:Reports:Index

API Context:Loyalty Club

Authorizations:User

Returns list of footfall reports for periods grouped by the reporting frequency.

Query Parameters

Parameter	Type	Default	Description
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
period_start	string	null	String that represents period range start - must match format with reporting frequency
period_end	string	null	String that represents period range end - must match format with reporting frequency

Example

When successful, returns object containing a list reporting periods

{
  "periods": [
    {
     "period_string": "2020-02-10",
     "value": 110,
     "start_date": "2020-02-10 00:00",
     "end_date": "2020-02-10 23:59"
    },
    {
     "period_string": "2020-02-11",
     "value": 110,
     "start_date": "2020-02-11 00:00",
     "end_date": "2020-02-11 23:59"
    }
  ],
  "meta": { "is_last_page": true }
}

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/operations/footfall_reporting/reports' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-05-07 15:49:13

Destroy Alert Template

Bulk Update Reports

List Footfall Reports

Query Parameters#

Example#

Request

Request samples

Responses

Query Parameters

Example