Explain Sending Text KPI Prediction v1

POST

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

API Permit:ML:Sending:ExplainTextKPIPrediction

API Context:Loyalty Club

Authorizations:UserToken

Explains prediction for a specific sending text and selected KPI.

Body Parameters

Parameter	Type	Required?	Description
channel	String	Yes	Channel of sending. One of ["sms", "push", "email"]
kpi	String	Yes	KPI of sending. One of ["ctr", "open_rate"]
text	String	Yes	Text to explain

Example

When successful, returns:

{
  "channel": email,
  "kpi": "ctr",
  "influences: [0.1 0.1 0.1 0.1 0 -0.05 -0.05 -0.05 -0.05 -0.05 -0.05 -0.05 -0.05]
}

Request

Header Params

Body Params application/json

Example

{
    "channel": "email",
    "kpi": "ctr",
    "text": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/ml/sending/explain_text_kpi_prediction' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'X-Customer: 447' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "email",
    "kpi": "ctr",
    "text": "string"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "influences": [
        0
    ]
}

Predict Sending KPI In Date Range v1

Predict Sending Text Popularity

Explain Sending Text KPI Prediction v1

Body Parameters#

Example#

Request

Request Code Samples

Responses

Body Parameters

Example