openapi: 3.0.0
info:
  version: 1.0.0
  title: Segmint Data Services API
  description: "#### Impressions\nClick here to find out more aboutRetrieve information about a single campaign impression using an Impression
    ID, which can be obtained from the results of other endpoints.\n\n\n#### Integrations\n
    When integrating with Segmint's APIs you should always allow for unknown fields.
    Segmint reserves the right to add additional fields to its APIs. Segmint will
    always attempt to not introduce breaking changes into an endpoint. This is often
    accomplished by the addition of fields. If a breaking change is required clients
    will be given advanced notice to make the required changes.\n\nAccess to API endpoints
    may be rate limited and have monthly account level quotas, your account representative
    will have details if this applies to you."
servers:
- url: https://dataservices-demo.segmint.net/
- url: https://dataservices.segmint.net/
- url: https://dataservices-stage.segmint.net
paths:
  "/impression/v1/partners/{partner_id}/impressions/{impression_id}":
    get:
      summary: Details for a single Impression
      description: |- 
        Call this API passing a Segmint supplied partner_id and an impression_id and get back details about the impression.
        ### <span style="color:var(--red)">Fields marked with an * are required. </span>
      responses:
        '200':
          description: Ok
          content:
            "*/*":
              schema:
                "$ref": "#/components/schemas/Impression"
        '401':
          "$ref": "#/components/responses/UnauthorizedError"
        '404':
          description: Not found
        '500':
          description: Server error
      security:
      - BearerAuthentication: []
      parameters:
      - name: partner_id
        in: path
        required: true
        description: Partner ID provided to the Financial Institution by Segmint.
        schema:
          type: integer
      - name: impression_id
        in: path
        required: true
        description: Unique ID of the requested campaign impression.
        schema:
          type: integer
          format: int64
      tags:
      - "/impression"
components:
  responses:
    UnauthorizedError:
      description: Unauthorized
    BadRequest:
      description: Bad Request. Check your credentials
    BadPasswordUpperCase:
      description: 'Password did not conform with policy: Password must have uppercase
        characters'
    BadPasswordLowerCase:
      description: 'Password did not conform with policy: Password must have lowercase
        characters'
    BadPasswordLength:
      description: New password must have a length greater than 8
    BadPasswordSpecial:
      description: 'Password did not conform with policy: Password must have symbol
        characters'
      content:
        application/json:
          schema:
            "$ref": "#/components/schemas/PasswordErrors"
    ToManyRequests:
      description: You have exceeded your throughput rate or quota for your account
        plan.
    Forbidden:
      description: You do not have permission to access this resource.
  securitySchemes:
    BearerAuthentication:
      type: http
      description: Obtain a token using the /auth/v1/token endpoint
      scheme: bearer
      bearerFormat: JWT
  schemas:
    Impression:
      properties:
        impression_id:
          type: integer
          format: int64
          description: Unique ID for the impression.
          example: 1394760616186487000
        campaign_id:
          type: integer
          description: Unique ID for the campaign associated to the impression.
          example: 5001
        campaign_name:
          type: string
          description: Descriptive name, assigned by the partner, for the campaign
            associated to the impression.
          example: BUSINESS LINE OF CREDIT
        channel_id:
          type: integer
          description: Unique ID for the channel associated to the impression.
          example: 138
        channel_name:
          type: string
          description: Descriptive name for the channel associated to the impression.
          example: TELLERINSIGHT
        media_id:
          type: integer
          description: Unique ID for the media associated to the impression.
          example: 14744
        media_name:
          type: string
          description: Descriptive name of the media associated to the impression.
          example: Campaign Media 1
        cookie_id:
          type: string
          description: Segmint assigned cookie ID associated to the customer that
            was served the impression.
          example: a56a621d2bde47139b496744d46da68c
        ucic:
          type: string
          description: Unique customer identification code of the customer that was
            served the impression.
          example: e2c96790-fd69-11e8-9ff7-bf083b0e566c
        campaign_kli_equation:
          type: string
          description: An equation made up of KLIs used to define the targeted customer
            audience for the campaign associated to the impression. Customers whose
            KLI set matches this equation are included in the campaign target audience
            population.
          example: "(+ 10752500 (!(+ 8616313)))"
        ucic_kli_assignments:
          type: string
          description: The set of KLIs assigned to the customer at the time the impression
            was served
          example:
          - 16111934
          - 32322086
          - 34426758
          - 10595183
          - 8616211
          - 10595185
          - 10752500
          - 43136643
        impression_created_date:
          type: string
          description: Timestamp (UTC) of impression served date.