openapi: 3.0.0
info:
  version: 1.0.0
  title: Segmint Data Services API
  description: "#### Click\nRetrieve
    a list of customers that clicked on a message (ads) served to them. Pull all click
    data or filter click data based on the campaign goal or click date.\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.\n\n\n\nClick here to find out more about"
servers:
- url: https://dataservices-demo.segmint.net/
- url: https://dataservices-stage.segmint.net
- url: https://dataservices.segmint.net/
paths:
  "/click/v1/partners/{partner_id}/clicks":
    get:
      summary: Details for campaign media click events
      description: |-
        Call this API passing a Segmint supplied partner_id and query parameters to retrieve the list of ads that customers clicked.
        - Filter the list by campaign_goal_kli_code to limit the list with only those ads associated with a specific campaign goal, such as Consumer Certificates of Deposit (8616200).
        - Filter the list by from_date and to_date to limit the list with only those ads clicked within a specific date range.
        ### <span style="color:var(--red)">Fields marked with an * are required. </span>
      responses:
        '200':
          description: Ok
          content:
            "*/*":
              schema:
                "$ref": "#/components/schemas/AllClicksDetail"
        '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: campaign_goal_kli_code
        in: query
        description: KLI code of the campaign goal for which click events are being
          searched.
        schema:
          type: integer
      - name: from_date
        in: query
        description: Search start date (YYYY-MM-DD).
        schema:
          type: string
      - name: to_date
        in: query
        description: Search end date (YYYY-MM-DD).
        schema:
          type: string
      - name: limit
        in: query
        description: Number of rows to be returned per page (default 1000).
        schema:
          type: integer
      - name: offset
        in: query
        description: Row number to start returning data.
        schema:
          type: integer
      tags:
      - "/click"
  AllClicksDetail:
      properties:
        metadata:
          type: object
          properties:
            limit:
              type: integer
              description: Number of rows to be returned per page for this query.
              example: 5
            offset:
              type: integer
              description: Row number to start returning data.
              example: 0
            current:
              type: string
              description: URL for the current page of data.
              example: https://dataservices-demo.segmint.net/ucic/v1/partners/12345678/ucics?ucic_type=O&ucic_is_active=TRUE&limit=10
            next:
              type: string
              description: URL for the next page of data.
              example: https://dataservices-demo.segmint.net/ucic/v1/partners/12345678/ucics?ucic_type=O&ucic_is_active=TRUE&limit=10&offset=10
        content:
          type: array
          items:
            type: object
            properties:
              ucic:
                type: string
                description: Unique customer identification code assigned to the customer
                  by the FI.
                example: e2c96790-fd69-11e8-9ff7-bf083b0e566c
              campaign_id:
                type: integer
                description: Unique ID for the campaign associated to the media that
                  was clicked.
                example: 12345
              campaign_name:
                type: string
                description: Descriptive name, assigned by the partner, for the campaign
                  associated to the media that was clicked.
                example: HELOC Utilization Campaign
              campaign_goal_kli_code:
                type: integer
                description: KLI code associated to the campaign goal.
                example: 8616234
              campaign_goal_kli_name:
                type: string
                description: KLI description associated to the campaign goal.
                example: PROMOTIONS
              campaign_channel_id:
                type: integer
                description: Unique ID for the channel to which the clicked media
                  was served.
                example: 12345
              campaign_channel_name:
                type: string
                description: Descriptive name for the channel.
                example: Public Site
              campaign_media_id:
                type: integer
                description: Unique ID for the media that was clicked..
                example: 12345
              campaign_media_name:
                type: string
                description: Descriptive name of the media.
                example: HELOC High Utilization
              campaign_zone_id:
                type: integer
                description: The id of the zone that this media was served in.
                example: 12345
              click_created_date:
                type: string
                description: The timestamp of when the click occured. This is a ISO
                  8601 timestamp.
                example: '2016-02-07 21:28:25.515000+00:00'
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
