- Introduction
- Filter parameter specification
- Data formats
- Reports
- Geo API
- MetadataPOST
- Field metadataPOST
- Query (records)POST
- Query (timeseries)POST
- Query (records) exportPOST
- Query (timeseries) exportPOST
- Tenants query (records) export POST
- Tenants query (timeseries) exportPOST
Metadata
POST
https://api.mpc.dev.placewise.com/v1/reporting/metadata
API Permit:Reporting:Api:Query
API Context:Customer
Authorizations:UserToken
Request
Header Params
Body Params application/json
Example
{
"report": "members_grouped_count"
}Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/reporting/metadata' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"report": "members_grouped_count"
}'Responses
🟢200Success
application/json
Body
Example
{"description":"Fetch current (grouped by type and values) number of members in loyalty clubs","aggregate_by":{"by_grouping_type_and_value":{"sort_by":["grouping_type"]}},"fields":{"loyalty_club_id":{"type":"integer"},"grouping_type":{"type":"enum","possible_values":["optin_channel","optin_subchannel","optin_platform","birth_year_group","consent_true","consent_false","marketing_true","marketing_false","subunit_id","group_id","favorite_store","country","gender"]},"grouping_value":{"type":"text"}},"result_type":"records","sort_by":["loyalty_club_id","grouping_type"]}