# Explain Sending Text KPI Prediction v1

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/ml/sending/explain_text_kpi_prediction:
    post:
      summary: Explain Sending Text KPI Prediction v1
      deprecated: false
      description: >-
        Explains prediction for a specific sending text and selected KPI.


        ## Body Parameters


        | Parameter | Type  | Required? |
        Description                                                                 
        |

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

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

        | kpi | String | Yes       | KPI of sending. One of ["ctr",
        "open_rate"]                       |

        | text | String | Yes       | Text to
        explain                                                   |


        ## Example


        ```shell

        curl -X POST \

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

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

        -H 'Authorization: Bearer B7t9U9tsoWsGhrv2ouUoSqpM' \

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

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

        -d '{
              "channel": "email",
              "kpi": "ctr",
              "text": "Cool content",
        }'

        ```


        > When successful, returns:

        ```json

        {
          "channel": email,
          "kpi": "ctr",
          "influences: [0.1 0.1 0.1 0.1 0 -0.05 -0.05 -0.05 -0.05 -0.05 -0.05 -0.05 -0.05]
        }

        ```
      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:
                channel:
                  type: string
                  enum:
                    - email
                    - push
                    - sms
                  x-apidog-enum:
                    - value: email
                      name: ''
                      description: ''
                    - value: push
                      name: ''
                      description: ''
                    - value: sms
                      name: ''
                      description: ''
                kpi:
                  type: string
                  enum:
                    - ctr
                    - open_rate
                  x-apidog-enum:
                    - value: ctr
                      name: ''
                      description: ''
                    - value: open_rate
                      name: ''
                      description: ''
                text:
                  type: string
              x-apidog-orders:
                - channel
                - kpi
                - text
              required:
                - channel
                - kpi
                - text
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  influences:
                    type: array
                    items:
                      type: integer
                    description: >-
                      Influence of each character in the input text. Each
                      character in a given word has the same influence.
                x-apidog-orders:
                  - influences
                required:
                  - influences
          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-3998766-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```