Explain Sending Time Series Popularity Prediction v2

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 and selected KPI based on historical KPI time series.

Body Parameters

Parameter	Type	Required?	Description
sending_date	Datetime	yes	Date of sending, ISO 8601 format.
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:

{
  "dates": [
    "2025-03-28",
    "2025-03-29",
    "2025-03-30"
  ],
  "predictions": [
    7.6644820793970885,
    7.6647581507025695,
    7.664979007746955
  ],
  "low_50_percentiles": [
    2.585277421222262,
    2.5597992934271305,
    2.534362770369186
  ],
  "high_50_percentiles": [
    12.743686737571915,
    12.76971700797801,
    12.795595245124723
  ],
  "low_95_percentiles": [
    0,
    0,
    0,
  ],
  "high_95_percentiles": [
    22.423873452263305,
    22.498987284518,
    22.573764561320587
  ]
}

Request

Header Params

Body Params application/json

Example

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

Request Code 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_text_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": "email",
    "kpi": "ctr",
    "sending_date": "string"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "dates": [
        "string"
    ],
    "predictions": [
        0
    ],
    "low_50_percentiles": [
        0
    ],
    "high_50_percentiles": [
        0
    ],
    "low_95_percentiles": [
        0
    ],
    "high_95_percentiles": [
        0
    ]
}

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

Explain Sending Text Popularity Prediction v2

Recommend sending time v2

Explain Sending Time Series Popularity Prediction v2

Body Parameters#

Example#

Request

Request Code Samples

Responses

Body Parameters

Example