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

# Get integration usage



## OpenAPI

````yaml /api/openapi.yaml get /integrations/{service}/usage
openapi: 3.1.0
info:
  title: Beeze API
  version: v1
  description: >
    External Beeze API for pricing intelligence, domain research, AI Search, and
    integrations.
servers:
  - url: https://api.beeze.io/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: AI Search
    description: Results, visibility, sources, competitors, prompts, and tags
  - name: Domain research
    description: Pricing intelligence, backlinks, prospects, overview stats, and trends
  - name: Integrations
    description: Usage for connected third-party integrations
paths:
  /integrations/{service}/usage:
    get:
      tags:
        - Integrations
      summary: Get integration usage
      operationId: getIntegrationUsage
      parameters:
        - $ref: '#/components/parameters/Service'
      responses:
        '200':
          description: Usage response for the requested service
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/AhrefsUsage'
                    required:
                      - data
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/HunterUsage'
                    required:
                      - data
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/MajesticUsage'
                    required:
                      - data
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/OxylabsUsage'
                    required:
                      - data
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Service:
      name: service
      in: path
      required: true
      schema:
        type: string
        enum:
          - ahrefs
          - hunter
          - majestic
          - oxylabs
  schemas:
    AhrefsUsage:
      type: object
      properties:
        subscription:
          type: string
        usageResetDate:
          type: string
        apiKeyExpiration:
          type: string
        unitsLimit:
          oneOf:
            - type: number
            - type: string
              enum:
                - Unlimited
        unitsUsed:
          type: number
        unitsUsedApiKey:
          type: number
        unitsRemaining:
          oneOf:
            - type: number
            - type: string
              enum:
                - Unlimited
        percentageUsed:
          type: string
      required:
        - subscription
        - usageResetDate
        - apiKeyExpiration
        - unitsLimit
        - unitsUsed
        - unitsUsedApiKey
        - unitsRemaining
        - percentageUsed
    HunterUsage:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        planName:
          type: string
        planLevel:
          type: number
        resetDate:
          type: string
        searches:
          type: object
          properties:
            used:
              type: number
            available:
              type: number
          required:
            - used
            - available
        verifications:
          type: object
          properties:
            used:
              type: number
            available:
              type: number
          required:
            - used
            - available
      required:
        - firstName
        - lastName
        - email
        - planName
        - planLevel
        - resetDate
        - searches
        - verifications
    MajesticUsage:
      type: object
      properties:
        subscription:
          type: object
          properties:
            expires:
              type: string
            analysisResUnits:
              type: number
            retrievalResUnits:
              type: number
            detailedReportsPerPeriodRemaining:
              type: number
            title:
              type: string
          required:
            - expires
            - analysisResUnits
            - retrievalResUnits
            - detailedReportsPerPeriodRemaining
            - title
      required:
        - subscription
    OxylabsUsage:
      type: object
      properties:
        totalRequests:
          type: number
        requestTraffic:
          type: number
        responseTraffic:
          type: number
        averageResponseTime:
          type: number
        integrationMethods:
          type: object
          properties:
            callbackMode:
              type: number
            realtimeMode:
              type: number
            superApiMode:
              type: number
          required:
            - callbackMode
            - realtimeMode
            - superApiMode
        contentTypes:
          type: object
          properties:
            parsedResults:
              type: number
            htmlResults:
              type: number
          required:
            - parsedResults
            - htmlResults
        geoLocationCount:
          type: number
        renderCount:
          type: number
        sources:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              requestCount:
                type: number
              requestTraffic:
                type: number
              responseTraffic:
                type: number
              averageResponseTime:
                type: number
            required:
              - name
              - requestCount
              - requestTraffic
              - responseTraffic
              - averageResponseTime
      required:
        - totalRequests
        - requestTraffic
        - responseTraffic
        - averageResponseTime
        - integrationMethods
        - contentTypes
        - geoLocationCount
        - renderCount
        - sources
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        requestId:
          type: string
        instance:
          type: string
      required:
        - status
        - detail
        - code
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: Missing plan access, feature access, or workspace access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for external Beeze API access

````