# Explain Sending KPI Prediction v1 ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/ml/sending/explain_kpi_prediction: post: summary: Explain Sending KPI Prediction v1 deprecated: false description: >- Explains prediction for a specific sending and selected kpi. ## Body Parameters | Parameter | Type | Required? | Description | |-----------|--------------|-----------|-------------------------------------------------------------------| | payload | Array[Hash] | Yes | Array of objects with the following fields: ["channel", "kpi", "model_input"] | | payload[].channel | String | Yes | Channel of sending. One of ["sms", "push", "email"] | | payload[].kpi | String | Yes | KPI of sending. One of ["ctr", "open_rate"] | | payload[].model_input | Hash | Yes | Object with model input features. See example payload below in [example](api-3511408#example).| ## Example ```shell curl -X POST \ "https://api.mpc.placewise.com/v1/ml/sending/explain_kpi_prediction" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer B7t9U9tsoWsGhrv2ouUoSqpM' \ -H 'x-product-name: default' \ -H 'x-user-agent: CURL manual test' \ -d '{ "payload": [ { "channel": "sms", "kpi": "ctr", "model_input": { "sent_age_group_15_19": 0.0, "sent_age_group_20_24": 0.0, "sent_age_group_25_29": 0.0, "sent_age_group_30_34": 0.0, "sent_age_group_35_39": 0.0, "sent_age_group_40_44": 0.0, "sent_age_group_45_49": 0.0, "sent_age_group_50_54": 0.0, "sent_age_group_55_59": 0.0, "sent_age_group_60_64": 0.0, "sent_age_group_65_69": 0.0, "sent_age_group_70_plus": 0.0, "sent_age_group_unknown": 0.0, "sent_gender_female": 0.0, "sent_gender_male": 0.0, "sent_gender_unknown": 0.0, "audience_avg_ctr_age_0_20": 0, "audience_avg_ctr_age_21_40": 0.0, "audience_avg_ctr_age_41_plus": 0.0, "audience_avg_ctr_age_unknown": 0.0, "audience_avg_open_rate_age_0_20": 0.0, "audience_avg_open_rate_age_21_40": 0.0, "audience_avg_open_rate_age_41_plus": 0.0, "audience_avg_open_rate_age_unknown": 0.0, "HourWeekDayMeanTargetTransformer": 0.0, "WeekDayChannelMeanTargetTransformer": 0.0, "HourChannelMeanTargetTransformer": 0.0, "MonthMeanTargetTransformer": 0.0, "week": 32, "sent": 100, "seasonal": -0.0, "trend": 0.0, "natural_language_kpi_transformer_features_content_en_embeddings": 0.0, "content_length": 4.0, "content_has_high_positive_correlation_word": 0, "content_sentiment_magnitude": 0.0, "topic_4": 0.0, "topic_5": 0.0, "topic_6": 0.0, "topic_7": 0.0, "topic_8": 0.0, "topic_9": 0.0, "topic_10": 0.0, "topic_12": 0.0, "topic_14": 0.0, "topic_16": 0.0, "topic_18": 0.0, "topic_19": 0.0, } } ] }' ``` > When successful, returns: ```json [ { "base_value": 0.0, "features": [ { "name": "sent", "effect": 0.0, "value": 0.1 } ], "kpi": "ctr" } ] ``` tags: - API Reference/ML API/Sendings/Deprecated parameters: - name: Content-Type in: header description: '[Details](doc-341635)' required: true example: application/json schema: type: string default: application/json const: application/json - name: X-User-Agent in: header description: Arbitrary identifier of your client. [Details](doc-341635) required: true example: '{{X_USER_AGENT}}' schema: type: string default: '{{X_USER_AGENT}}' - name: X-Product-Name in: header description: API Product for API context. [Details](doc-341635) required: true example: '{{PRODUCT_NAME}}' schema: type: string default: '{{PRODUCT_NAME}}' - name: X-Loyalty-Club-Slug in: header description: LoyaltyClub for API context. [Details](doc-342138) required: false example: '{{LOYALTY_CLUB_SLUG}}' schema: type: string default: '{{LOYALTY_CLUB_SLUG}}' - name: X-Customer in: header description: Customer for API context. [Details](doc-342139) required: false example: '{{CUSTOMER_ID}}' schema: type: string default: '{{CUSTOMER_ID}}' - name: Authorization in: header description: '[Member](doc-342129) or [User](doc-342130) Authorization.' required: false example: Bearer {{_OAUTH_TOKEN}} schema: type: string default: Bearer {{_OAUTH_TOKEN}} - name: X-Client-Authorization in: header description: '[Token](doc-342128) Authorization.' example: '{{API_TOKEN}}' schema: type: string default: '{{API_TOKEN}}' requestBody: content: application/json: schema: type: object properties: 01JRSZKFEVKAMSYS41XQXRVDSD: type: string x-apidog-orders: - 01JRSZKFEVKAMSYS41XQXRVDSD required: - 01JRSZKFEVKAMSYS41XQXRVDSD examples: {} responses: '200': description: '' content: application/json: schema: type: object properties: title: type: string content: type: string channel: type: string enum: - email - push - sms x-apidog-enum: - value: email name: '' description: '' - value: push name: '' description: '' - value: sms name: '' description: '' scheduled_datetime: type: string description: ISO 8601 datetime audience_conditions: type: array items: type: object properties: {} x-apidog-orders: [] description: List of audience conditions kpi: type: array items: type: string enum: - ctr - open_rate x-apidog-enum: - value: ctr name: '' description: '' - value: open_rate name: '' description: '' x-apidog-orders: - title - content - channel - scheduled_datetime - audience_conditions - kpi required: - title - content - channel - scheduled_datetime - audience_conditions - kpi headers: {} x-apidog-name: Success security: [] x-apidog-folder: API Reference/ML API/Sendings/Deprecated x-apidog-status: released x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511408-run components: schemas: {} securitySchemes: {} servers: - url: https://api.mpc.dev.placewise.com description: Staging security: [] ```