- Overview
- Introduction
- Hosts
- Global Headers
- Common HTTP Error Codes
- API Permits
- Authorization
- API Contexts
- Common Concepts
- Common Models
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- SMS Sender Identities
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Pages
- Components
- Website
- Website Domains
- Venue Info
- Landing Pages
- Landing Page Templates
- Articles
- Events
- Events Groups
- Job Postings
- Press Releases
- Tags
- Service Messages
- Content Prototypes
- ContentPrototype Model
- List Content Prototypes
- Show Content Prototype
- Create Content Prototype
- Update Content Prototype
- Destroy Content Prototype
- List Organization Content Prototypes
- Show Organization Content Prototype
- Create Organization Content Prototype
- Update Organization Content Prototype
- Destroy Organization Content Prototype
- Mixed Content
- Attachments
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Tenant API
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Generate Image
- Generate Text
- Generate Sending Text
- (Draft) Reporting API
- Other
Field metadata
Designing
POST
https://api.mpc.dev.placewise.com/v1/reporting/metadata/{field_name}
API Permit:Reporting:Api:Query
API Context:Customer
Authorizations:UserToken
Request
Path Params
field_name
stringÂ
required
Example:
grouping_type
Header Params
X-Client-Authorization
stringÂ
optional
Default:
{{API_TOKEN}}
Body Params application/json
report
stringÂ
required
Example
{
"report": "members_grouped_count"
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/reporting/metadata/grouping_type' \
--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
value
objectÂ
required
type
stringÂ
required
values
array[string]
required
possible_values
array[string]
required
Example
{
"value": {
"type": "enum",
"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"
],
"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"
]
}
}
Modified at 2024-07-31 21:15:25