# Predict Sending KPI v1

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/ml/sending/predict_sending_kpi:
    post:
      summary: Predict Sending KPI v1
      deprecated: false
      description: >-
        Returns predictions for selected KPI for a given sending entity.


        ## Body Parameters


        | Parameter           | Type           | Required? |
        Description                                                |

        |---------------------|----------------|-----------|------------------------------------------------------------|

        | title               | String         | yes       | Title of
        sending.                                          |

        | content             | String         | yes       | Content of
        sending.                                        |

        | channel             | String         | yes       | Channel of sending.
        One of ["email", "push", "sms"].       |

        | scheduled_datetime  | Date           | yes       | Scheduled datetime
        of sending. Format: "YYYY-MM-DD HH:MM:SS"|

        | audience_conditions | Array[Object]  | yes       | Audience conditions
        of sending.                             |

        | kpi                 | Array[String]  | yes       | KPIs to predict.
        One of ["ctr", "open_rate"].               |


        ## Example


        ```shell

        curl -X POST \

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

        -H 'Content-Type: application/json' \

        -H 'Authorization: Bearer B7t9U9tsoWsGhrv2ouUoSqpM' \

        -H 'x-product-name: default' \

        -H 'x-user-agent: CURL manual test' \

        -d '{
          "title": "Cool sending",
          "content": "Cool content",
          "channel": "email",
          "scheduled_datetime": "2020-01-01 00:00:00",
          "audience_conditions": [
            {
              "condition_group": "member_properties",
              "field": "gender",
              "operator": "in",
              "value": ["man"]
            }
          ],
          "kpi": ["ctr", "open_rate"]
        }'

        ```


        > When successful, returns:

        ```json

        {
          "predictions": [
            {
              "kpi": "ctr",
              "predictions": [
                {
                  "score": 0.5,
                  "upper_bound": 0.1,
                  "bottom_bound": 0.9,
                  "input": {
                    // model input features, after processing ...
                  }
                }
              ],
              "model_config": {
                "predictions_upper_threshold": 0.5
              }
            }
          ]
        }

        ```
      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}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          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-3511406-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```