> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stairoids.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Attribution by source

> Traffic sources with visit counts, UTM coverage, and known-company / signal breakdowns.



## OpenAPI

````yaml https://app.stairoids.com/api/docs/public post /public/v1/attribution
openapi: 3.0.1
info:
  title: Stairoids API
  description: The Next Generation API
  version: '1.0'
servers:
  - url: http://app.stairoids.com/api
    description: Generated server url
security:
  - ApiKeyAuth: []
tags:
  - name: Public API - Funnel
    description: Funnel stages, distribution, and pipeline trend metrics.
  - name: Public API - Attribution
    description: Traffic sources, campaigns, and the accounts they drove.
  - name: Public API - Lead Scores
    description: Signal details and per-person scores.
  - name: Public API - Reference
    description: Your ICPs, personas, labels, account lists, and signal categories.
  - name: Public API - Activity
    description: Per-person and general (cross-company) signal feeds.
  - name: Public API - LinkedIn Ads
    description: LinkedIn ad campaigns, posts, likes, and company engagement.
  - name: Public API - Companies
    description: Search, look up, and read activity for scored companies.
  - name: Public API - Opportunities
    description: Your best outreach opportunities right now.
paths:
  /public/v1/attribution:
    post:
      tags:
        - Public API - Attribution
      summary: Attribution by source
      description: >-
        Traffic sources with visit counts, UTM coverage, and known-company /
        signal breakdowns.
      operationId: getPublicAttribution
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicFunnelFilterRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicAttributionDTO'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomError'
        '402':
          description: Payment Required
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PlanLimitError'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgencyLimitError'
        '500':
          description: Internal Server Error
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomError'
components:
  schemas:
    PublicFunnelFilterRequest:
      type: object
      properties:
        startDate:
          type: integer
          description: >-
            Window start, epoch millis. Omit both startDate and endDate for the
            default recent window.
          format: int64
          example: 1717200000000
        endDate:
          type: integer
          description: Window end, epoch millis.
          format: int64
          example: 1719792000000
        icpIds:
          type: array
          description: Restrict to these ICP ids. Null or empty = all ICPs.
          items:
            type: integer
            description: Restrict to these ICP ids. Null or empty = all ICPs.
            format: int64
        accountListIds:
          type: array
          description: Restrict to these account-list ids. Null or empty = all lists.
          items:
            type: integer
            description: Restrict to these account-list ids. Null or empty = all lists.
            format: int64
      description: Time-window and segment filter for analytics endpoints.
    PublicAttributionDTO:
      type: object
      properties:
        totalVisits:
          type: integer
          description: Total tracked visits in the window.
          format: int64
          example: 5230
        withUtm:
          type: integer
          description: Visits that carried UTM parameters.
          format: int64
          example: 3110
        utmCoverage:
          type: number
          description: Share of visits with UTM data (0-100).
          format: double
          example: 59.5
        sources:
          type: array
          description: Per-source breakdown.
          items:
            $ref: '#/components/schemas/PublicAttributionSourceDTO'
      description: 'Marketing attribution: traffic sources and their pipeline impact.'
    CustomError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - TRIAL_NOT_ELIGIBLE
    PlanLimitError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - TRIAL_NOT_ELIGIBLE
        category:
          type: string
        currentUsage:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        addOnSlug:
          type: string
        planSlug:
          type: string
        addOnPriceMonthly:
          type: integer
          format: int32
        upgradePlanSlug:
          type: string
        upgradePlanName:
          type: string
        upgradePlanPriceMonthly:
          type: integer
          format: int32
    AgencyLimitError:
      type: object
      properties:
        errorType:
          type: string
          enum:
            - EMAIL_ALREADY_EXISTS
            - INVALID_EMAIL
            - UNAUTHORIZED
            - UNEXPECTED_ERROR
            - WRONG_PASSWORD
            - STILL_GENERATING
            - MISSING_HEADERS
            - USER_NOT_FOUND
            - WEAK_PASSWORD
            - VALIDATION_ERROR
            - NOT_FOUND
            - PLAN_LIMIT_EXCEEDED
            - FEATURE_NOT_AVAILABLE
            - PAYMENT_ERROR
            - ACTIVE_SUBSCRIPTION_EXISTS
            - AGENCY_LIMIT_EXCEEDED
            - PAYMENT_METHOD_REQUIRED
            - BILLED_BY_AGENCY
            - PAYMENT_AUTHENTICATION_REQUIRED
            - PLAN_BELOW_RECOMMENDED
            - TRIAL_NOT_ELIGIBLE
        category:
          type: string
        currentUsage:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
    PublicAttributionSourceDTO:
      type: object
      properties:
        id:
          type: string
          description: Source id.
          example: linkedin
        name:
          type: string
          description: Source name.
          example: LinkedIn
        visits:
          type: integer
          description: Visits from this source.
          format: int64
          example: 1840
        withUtm:
          type: integer
          description: Visits from this source with UTM data.
          format: int64
          example: 1700
        utmPercentage:
          type: number
          description: Share of this source's visits with UTM (0-100).
          format: double
          example: 92.4
        knownCompanies:
          type: integer
          description: Distinct known companies from this source.
          format: int64
          example: 420
        companiesWithSignals:
          type: integer
          description: Known companies from this source that have buying signals.
          format: int64
          example: 190
        funnelStages:
          type: object
          additionalProperties:
            type: integer
            description: Company counts by funnel stage name for this source.
            format: int64
          description: Company counts by funnel stage name for this source.
      description: A single traffic source and its pipeline impact.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your organization's public API key. Manage it at GET
        /api/user/public-api-key.
      name: X-Api-Key
      in: header

````