LinkedIn Use Cases > B2B Templates > Conversions Deep Dive API

openapi: 3.1.0
info:
  title: LinkedIn Compliance Events Access Control Use Cases > B2B Templates > Conversions Deep Dive API
  description: LinkedIn provides Compliance API Guides for monitoring, archiving, and management of communications for enterprises in regulated industries. The Compliance Events API allows applications to archive all LinkedIn activities from the past 30 days of a regulated, authenticated member.
  version: 1.0.0
  contact:
    name: LinkedIn API Support
    url: https://docs.microsoft.com/en-us/linkedin/compliance/
servers:
- url: https://api.linkedin.com
  description: LinkedIn Production API Server
security:
- OAuth2Auth:
  - r_compliance
tags:
- name: Use Cases > B2B Templates > Conversions Deep Dive
  description: This template provides detailed conversion analyses, ideal for in-flight optimization, check-ins, QBRs
paths:
  /adAnalytics:
    get:
      tags:
      - Use Cases > B2B Templates > Conversions Deep Dive
      summary: LinkedIn Conversions by Member Company Size
      parameters:
      - name: LinkedIn-Version
        in: header
        schema:
          type: string
        example: '{{insert_version}}'
      - name: X-Restli-Protocol-Version
        in: header
        schema:
          type: string
        example: 2.0.0
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{insert_token}}
      - name: q
        in: query
        schema:
          type: string
        example: analytics
      - name: pivot
        in: query
        schema:
          type: string
        example: MEMBER_COMPANY_SIZE
      - name: dateRange
        in: query
        schema:
          type: string
        example: (start:(day:1,month:1,year:2022),end:(day:31,month:12,year:2022))
      - name: timeGranularity
        in: query
        schema:
          type: string
        example: (value:ALL)
      - name: accounts
        in: query
        schema:
          type: string
        example: List(urn%3Ali%3AsponsoredAccount%3A{{sponsoredAccount}})
      - name: fields
        in: query
        schema:
          type: string
        example: externalWebsiteConversions,pivotValues
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
            X-RestLi-Protocol-Version:
              schema:
                type: string
                example: 2.0.0
            Date:
              schema:
                type: string
                example: Fri, 09 Jun 2023 08:34:51 GMT
            X-Li-Fabric:
              schema:
                type: string
                example: prod-ltx1
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Connection:
              schema:
                type: string
                example: keep-alive
            X-Li-Source-Fabric:
              schema:
                type: string
                example: prod-lva1
            X-Li-Pop:
              schema:
                type: string
                example: prod-lva1-x
            X-LI-Proto:
              schema:
                type: string
                example: http/1.1
            X-LI-UUID:
              schema:
                type: string
                example: AAX9rj4N6JgsAjUFoNOkWw==
            Set-Cookie:
              schema:
                type: string
                example: lidc="b=TB52:s=T:r=T:a=T:p=T:g=3861:u=592:x=1:i=1686299691:t=1686305165:v=2:sig=AQGuOtz49pASmSKUoFg-lXHMZbMOAgmM"
            X-LI-Route-Key:
              schema:
                type: string
                example: '"b=TB52:s=T:r=T:a=T:p=T:g=3861:u=592:x=1:i=1686299691:t=1686305165:v=2:sig=AQGuOtz49pASmSKUoFg-lXHMZbMOAgmM"'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionsByMemberCompanyResponse200'
              examples:
                default:
                  $ref: '#/components/examples/ConversionsByMemberCompanyResponse200Example'
      operationId: getConversionsByMemberCompany
      x-microcks-operation:
        dispatcher: FALLBACK
        dispatcherRules: '{}'
        delay: 0
components:
  schemas:
    ConversionsByMemberCompanyResponse200:
      type: object
      properties:
        paging:
          type: object
          properties:
            start:
              type: integer
            count:
              type: integer
            links:
              type: array
              items: {}
        elements:
          type: array
          items:
            type: object
            properties:
              pivotValues:
                type: array
                items:
                  type: string
              externalWebsiteConversions:
                type: integer
  examples:
    ConversionsByMemberCompanyResponse200Example:
      summary: Example 200 response for ConversionsByMemberCompany
      value:
        paging:
          start: 0
          count: 10
          links: []
        elements:
        - pivotValues:
          - SIZE_11_TO_50
          externalWebsiteConversions: 49
        - pivotValues:
          - SIZE_201_TO_500
          externalWebsiteConversions: 6
        - pivotValues:
          - SIZE_51_TO_200
          externalWebsiteConversions: 17
        - pivotValues:
          - SIZE_2_TO_10
          externalWebsiteConversions: 85
        - pivotValues:
          - SIZE_10001_OR_MORE
          externalWebsiteConversions: 4
        - pivotValues:
          - SIZE_1001_TO_5000
          externalWebsiteConversions: 8
        - pivotValues:
          - SIZE_501_TO_1000
          externalWebsiteConversions: 7
        - pivotValues:
          - SIZE_1
          externalWebsiteConversions: 12
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.linkedin.com/oauth/v2/authorization
          tokenUrl: https://www.linkedin.com/oauth/v2/accessToken
          scopes:
            r_compliance: Read compliance data