Predict Sending Text Popularity v2

POST

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

API Permit:ML:Sending:KPIPrediction

API Context:Loyalty Club

Authorizations:UserToken

Returns predictions for selected KPI for a given sending text. Version v2, with upgraded models.

Body Parameters

Parameter	Type	Required?	Description
text	String	yes	Text of sending. If it has title and content, combine them as one text.
channel	String	yes	Channel of sending. One of ["email", "push", "sms"].
kpi	String	yes	KPIs to predict. One of ["ctr", "open_rate"].

Example

When successful, returns:

{
  "prediction": 0.5
}

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

enum<string>

required

Allowed values:

emailpushsms

kpi

enum<string>

required

Allowed values:

ctropen_rate

text

string

required

Example

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

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/predict_sending_kpi' \
--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": "email",
    "kpi": "ctr",
    "text": "string"
}'

Responses

🟢200Success

application/json

Body

prediction

number

required

>= 0<= 1

Example

{
    "prediction": 0
}

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

Predict Sending Popularity v2

Predict Sending Time Series Popularity v2

Predict Sending Text Popularity v2

Body Parameters#

Example#

Request

Request samples

Responses

Body Parameters

Example