Placewise API

Explain Sending Popularity Prediction v2

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 sending popularity prediction for selected KPI for a given sending entity. Version v2, with upgraded models.

Body Parameters

Parameter	Type	Required?	Description
channel	String	yes	Channel of sending. One of ["email", "push", "sms"].
kpi	String	yes	KPI to predict. One of ["ctr", "open_rate"].
sending_date	Date	yes	Date of sending.
sending_hour	Integer	yes	Hour of sending in local time.
text	String	yes	Sending text. For emails, it should contain both title and content, separated with a space.

Warning: combination of "sms" channel and "open_rate" KPI is not supported.

Text should be as shown to the end user, without any HTML.

Example

When successful, returns:

{
  "feature_influences": {
    "sending_hour": 0.011576919053739497,
    "forecast": -0.017071377705380756,
    "text_pred": -0.16006355483664164,
    "historical_median": 0.3328648681685314
  }
}

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

channel

string

required

kpi

string

required

sending_date

string

required

sending_hour

integer

required

text

string

required

Example

{
  "channel": "sms",
  "kpi": "open_rate",
  "sending_date": "2024-04-20",
  "sending_hour": 16,
  "text": "Canis acervus maxime trepide conculco strues. Calco placeat ipsam tibi."
}

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 '{
    "channel": "sms",
    "kpi": "open_rate",
    "sending_date": "2024-04-20",
    "sending_hour": 16,
    "text": "Canis acervus maxime trepide conculco strues. Calco placeat ipsam tibi."
}'

Responses

🟢200Success

application/json

Body

feature_influences

object

required

sending_hour

number

required

forecast

number

required

text_pred

number

required

historical_median

number

required

Example

{
  "feature_influences": {
    "sending_hour": 0,
    "forecast": 0,
    "text_pred": 0,
    "historical_median": 0
  }
}

Modified at 2025-04-14 12:04:14

Predict Sending Time Series Popularity v2

Explain Sending Text Popularity Prediction v2

Explain Sending Popularity Prediction v2

Body Parameters#

Example#

Request

Request samples

Responses

Body Parameters

Example