Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting APIML API
Data API
ExplorePublic APIManagement APIUsers APIOperations APIMessaging APIReporting APIML API
Data API
  1. ML API
  • Introduction
  • Predict Sending KPI v1
    POST
  • Explain Sending KPI Prediction v1
    POST
  • Predict Sending KPI In Date Range v1
    POST
  • Predict Sending Popularity v2
    POST
  • Predict Sending Text Popularity v2
    POST
  • Predict Sending Time Series Popularity v2
    POST
  • Explain Sending Popularity Prediction v2
    POST
  • Explain Sending Text Popularity Prediction v2
    POST
  • Explain Sending Time Series Popularity Prediction v2
    POST
  • Recommend sending time v2
    POST
  • Detect receipt fraud
    POST
  • Predict item classes
    POST
  • Generate Image
    POST
  • Generate Image Caption
    POST
  • Generate Text
    POST
  • Generate Sending Text
    POST
  1. ML API

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#

ParameterTypeRequired?Description
sending_dateDatetimeyesDate of sending, ISO 8601 format.
channelStringyesChannel of sending. One of ["email", "push", "sms"].
kpiStringyesKPIs 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
Go
PHP
Python
HTTP
C#
Ruby
Request Request Example
Shell
JavaScript
Java
Swift
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: Bearer ' \
--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
    ]
}
Previous
Explain Sending Text Popularity Prediction v2
Next
Recommend sending time v2
Built with