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

# Profile an import source

> Manage schedules, transfers, destinations and import workflows.

Required scopes: `metrics:read`, `metrics:write`.


## OpenAPI

````yaml POST /api/v2/metrics/import-sources/{sourceObjectId}/profile
openapi: 3.1.1
info:
  title: chatobserver public API
  version: '2026-09-09'
  description: >-
    Track AI visibility, manage prompts, inspect collected answers and
    citations, and integrate workspace data with your own tools. Visibility
    endpoints use workspace API keys. Data endpoints use scoped service-account
    keys; spreadsheet client endpoints use authorised client sessions. See the
    authentication guide for each credential type.
  contact:
    name: chatobserver support
    url: https://chatobserver.com/contact
    email: support@chatobserver.com
servers:
  - url: https://app.chatobserver.com
    description: Production API
security:
  - WorkspaceKey: []
  - BearerKey: []
tags:
  - name: Workspace
    description: Validate access and list the workspace project and available platforms.
  - name: Prompts
    description: Create, schedule, organise, activate and retrieve tracked prompts.
  - name: Answers
    description: Retrieve collected AI answers, their analysis and visibility trends.
  - name: Brands
    description: Manage brands and compare their visibility in AI answers.
  - name: Sources and citations
    description: Analyse cited domains, pages and ownership across answers.
  - name: Visitor analytics
    description: Read website visitor and crawler analytics for the workspace.
  - name: Content opportunities
    description: Retrieve content-gap findings and recommendations for tracked prompts.
  - name: Usage
    description: Read workspace consumption and allowance summaries.
  - name: Data connections
    description: Discover authorised connections, source accounts and connector catalogues.
  - name: Data queries
    description: >-
      Create versioned queries, publish definitions and inspect integration
      contracts.
  - name: Data operations
    description: >-
      Execute, validate, cancel and inspect operations and page through result
      rows.
  - name: Data delivery
    description: Manage schedules, transfers, destinations and import workflows.
  - name: Data definitions
    description: Manage reusable definitions and their immutable versions.
  - name: Data webhooks
    description: >-
      Configure event delivery, inspect deliveries, replay events and rotate
      secrets.
  - name: Client authorisation
    description: Authorise spreadsheet clients using a user-approved challenge exchange.
  - name: Spreadsheet clients
    description: >-
      Access document-bound client sessions, queries, schedules, bindings and
      write claims.
  - name: AI visibility audits
    description: Create website visibility audits and retrieve their report links.
  - name: Version 1
    description: Integrate with the version 1 visibility and analytics endpoints.
paths:
  /api/v2/metrics/import-sources/{sourceObjectId}/profile:
    post:
      tags:
        - Data delivery
      summary: Profile an import source
      description: >-
        Manage schedules, transfers, destinations and import workflows. Required
        scopes: `metrics:read`, `metrics:write`.
      operationId: postV2MetricsImportSourcesSourceObjectIdProfile
      parameters:
        - name: sourceObjectId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Resource identifier returned by the API.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/postV2MetricsImportSourcesSourceObjectIdProfileRequest
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/postV2MetricsImportSourcesSourceObjectIdProfileResponse200
        default:
          description: >-
            Request failed. Inspect the error code and request identifier; retry
            only when the failure is retryable.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DataError'
                  - $ref: '#/components/schemas/ApiError'
components:
  schemas:
    postV2MetricsImportSourcesSourceObjectIdProfileRequest:
      type: object
      properties:
        sheetName:
          anyOf:
            - type: 'null'
            - type: string
              minLength: 1
              maxLength: 255
        headerRow:
          anyOf:
            - type: 'null'
            - type: integer
              minimum: 1
              maximum: 100
        delimiter:
          anyOf:
            - type: 'null'
            - type: string
              const: ','
            - type: string
              const: "\t"
            - type: string
              const: ;
            - type: string
              const: '|'
      additionalProperties: false
    postV2MetricsImportSourcesSourceObjectIdProfileResponse200:
      type: object
      properties:
        data:
          type: object
          properties:
            columns:
              type: array
              items:
                type: object
                properties:
                  nullable:
                    anyOf:
                      - type: boolean
                        const: false
                      - type: boolean
                        const: true
                  position:
                    type: number
                  sourceName:
                    type: string
                  suggestedFieldId:
                    type: string
                  suggestedLabel:
                    type: string
                  inferredType:
                    enum:
                      - string
                      - number
                      - boolean
                      - integer
                      - date
                      - json
                      - duration
                      - url
                      - percent
                      - currency
                      - datetime
                      - decimal
                      - image_url
                    type: string
                  populatedSamples:
                    type: number
                  distinctSamples:
                    type: number
                  sampleValues:
                    type: array
                    items:
                      anyOf:
                        - type: 'null'
                        - type: string
                        - type: number
                        - type: boolean
                          const: false
                        - type: boolean
                          const: true
                        - type: array
                          items:
                            $ref: '#/components/schemas/ContractType54286'
                        - type: object
                          properties: {}
                          additionalProperties:
                            $ref: '#/components/schemas/ContractType54286'
                required:
                  - nullable
                  - position
                  - sourceName
                  - suggestedFieldId
                  - suggestedLabel
                  - inferredType
                  - populatedSamples
                  - distinctSamples
                  - sampleValues
            workspaceId:
              type: string
            schemaVersion:
              type: number
              const: 1
            format:
              enum:
                - csv
                - parquet
                - tsv
                - xlsx
                - jsonl
              type: string
            sourceObjectId:
              type: string
            headerRow:
              anyOf:
                - type: 'null'
                - type: number
            firstDataRow:
              type: number
            delimiter:
              anyOf:
                - type: 'null'
                - type: string
                  const: ','
                - type: string
                  const: "\t"
                - type: string
                  const: ;
                - type: string
                  const: '|'
            schemaFingerprint:
              type: string
            sourceChecksumSha256:
              type: string
            sheetNames:
              type: array
              items:
                type: string
            selectedSheet:
              anyOf:
                - type: 'null'
                - type: string
            sampleRows:
              type: array
              items:
                type: object
                properties: {}
                additionalProperties:
                  anyOf:
                    - type: 'null'
                    - type: string
                    - type: number
                    - type: boolean
                      const: false
                    - type: boolean
                      const: true
                    - type: array
                      items:
                        $ref: '#/components/schemas/ContractType54286'
                    - type: object
                      properties: {}
                      additionalProperties:
                        $ref: '#/components/schemas/ContractType54286'
            sampledRowCount:
              type: number
            sampleLimit:
              type: number
            sourceByteCount:
              type: number
            truncated:
              anyOf:
                - type: boolean
                  const: false
                - type: boolean
                  const: true
          required:
            - columns
            - workspaceId
            - schemaVersion
            - format
            - sourceObjectId
            - headerRow
            - firstDataRow
            - delimiter
            - schemaFingerprint
            - sourceChecksumSha256
            - sheetNames
            - selectedSheet
            - sampleRows
            - sampledRowCount
            - sampleLimit
            - sourceByteCount
            - truncated
      required:
        - data
    DataError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              enum:
                - internal
                - validation_failed
                - authentication_required
                - forbidden
                - not_found
                - conflict
                - precondition_failed
                - idempotency_conflict
                - capability_unavailable
                - connection_unavailable
                - reauthentication_required
                - provider_rate_limited
                - workspace_limit_exceeded
                - result_expired
                - operation_failed
                - temporarily_unavailable
              type: string
            fieldPath:
              type: array
              items:
                anyOf:
                  - type: string
                  - type: number
            parameters:
              type: object
              properties: {}
              additionalProperties:
                anyOf:
                  - type: 'null'
                  - type: string
                  - type: number
                  - type: boolean
                    const: false
                  - type: boolean
                    const: true
            repairActions:
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 96
              maxItems: 10
            requestId:
              type: string
              minLength: 1
              maxLength: 160
            retryable:
              anyOf:
                - type: boolean
                  const: false
                - type: boolean
                  const: true
            retryAfterSeconds:
              anyOf:
                - type: 'null'
                - type: integer
                  exclusiveMinimum: 0
          required:
            - code
            - fieldPath
            - parameters
            - repairActions
            - requestId
            - retryable
            - retryAfterSeconds
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
        requestId:
          type: string
      required:
        - error
        - requestId
    ContractType54286:
      anyOf:
        - type: 'null'
        - type: string
        - type: number
        - type: boolean
          const: false
        - type: boolean
          const: true
        - type: array
          items:
            $ref: '#/components/schemas/ContractType54286'
        - type: object
          properties: {}
          additionalProperties:
            $ref: '#/components/schemas/ContractType54286'
  securitySchemes:
    WorkspaceKey:
      type: apiKey
      in: header
      name: x-chatobserver-key
      description: >-
        A workspace API key. Data endpoints require a service-account key with
        the specified scopes.
    BearerKey:
      type: http
      scheme: bearer
      description: The workspace or service-account API key as a bearer token.

````