Field metadata

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

Header Params

Body Params application/json

Example

{
    "report": "members_grouped_count"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

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: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "report": "members_grouped_count"
}'

Responses

🟢200Success

application/json

Body

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

Metadata

Query (records)