Placewise API

Explain Sending KPI Prediction v1

POST

https://api.mpc.dev.placewise.com/v1/ml/sending/explain_kpi_prediction

API Permit:ML:Sending:ExplainKPIPrediction

API Context:Loyalty Club

Authorizations:UserToken

Explains prediction for a specific sending and selected kpi.

Body Parameters

Parameter	Type	Required?	Description
payload	Array[Hash]	Yes	Array of objects with the following fields: ["channel", "kpi", "model_input"]
payload[].channel	String	Yes	Channel of sending. One of ["sms", "push", "email"]
payload[].kpi	String	Yes	KPI of sending. One of ["ctr", "open_rate"]
payload[].model_input	Hash	Yes	Object with model input features. See example payload below in example.

Example

When successful, returns:

[
  {
    "base_value": 0.0,
    "features": [
      {
        "name": "sent",
        "effect": 0.0,
        "value": 0.1
      }
    ],
    "kpi": "ctr"
  }
]

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

X-Client-Authorization

string

optional

Default:

Body Params application/json

object {0}

Example

{}

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/ml/sending/explain_kpi_prediction' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200Success

application/json

Body

title

string

required

content

string

required

channel

enum<string>

required

Allowed values:

emailpushsms

scheduled_datetime

string

required

ISO 8601 datetime

audience_conditions

array [object]

required

List of audience conditions

kpi

array[string]

required

Allowed values:

ctropen_rate

Example

{
  "title": "string",
  "content": "string",
  "channel": "email",
  "scheduled_datetime": "string",
  "audience_conditions": [
    {}
  ],
  "kpi": [
    "ctr"
  ]
}

Modified at 2025-04-14 11:56:42

Predict Sending KPI v1

Predict Sending KPI In Date Range v1

Explain Sending KPI Prediction v1

Body Parameters#

Example#

Request

Request samples

Responses

Body Parameters

Example