FullStory Segments Export API

naftiko: 1.0.0-alpha2
info:
  label: FullStory Segments Export API
  description: 'The FullStory Segments Export API provides an asynchronous workflow for downloading captured event data from
    FullStory. Developers can initiate export jobs to aggregate segment data, query for the status of running jobs, and retrieve
    download URLs for completed exports. Two types of segment data are available for export: individuals matching a segment
    and events performed by those individuals. This API is useful for integrating FullStory behavioral data into external
    analytics pipelines and data warehouses.'
  tags:
  - Fullstory
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: fullstory
    baseUri: https://api.fullstory.com
    description: FullStory Segments Export API HTTP API.
    authentication:
      type: basic
      username: '{{FULLSTORY_USERNAME}}'
      password: '{{FULLSTORY_PASSWORD}}'
    resources:
    - name: segments-v1
      path: /segments/v1
      operations:
      - name: listsegments
        method: GET
        description: List segments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: segments-v1-segmentid
      path: /segments/v1/{segmentId}
      operations:
      - name: getsegment
        method: GET
        description: Get a segment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: segments-v1-exports
      path: /segments/v1/exports
      operations:
      - name: createsegmentexport
        method: POST
        description: Create a segment export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: operations-v1-operationid
      path: /operations/v1/{operationId}
      operations:
      - name: getoperationstatus
        method: GET
        description: Get operation status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: fullstory-rest
    description: REST adapter for FullStory Segments Export API.
    resources:
    - path: /segments/v1
      name: listsegments
      operations:
      - method: GET
        name: listsegments
        description: List segments
        call: fullstory.listsegments
        outputParameters:
        - type: object
          mapping: $.
    - path: /segments/v1/{segmentId}
      name: getsegment
      operations:
      - method: GET
        name: getsegment
        description: Get a segment
        call: fullstory.getsegment
        outputParameters:
        - type: object
          mapping: $.
    - path: /segments/v1/exports
      name: createsegmentexport
      operations:
      - method: POST
        name: createsegmentexport
        description: Create a segment export
        call: fullstory.createsegmentexport
        outputParameters:
        - type: object
          mapping: $.
    - path: /operations/v1/{operationId}
      name: getoperationstatus
      operations:
      - method: GET
        name: getoperationstatus
        description: Get operation status
        call: fullstory.getoperationstatus
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: fullstory-mcp
    transport: http
    description: MCP adapter for FullStory Segments Export API for AI agent use.
    tools:
    - name: listsegments
      description: List segments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fullstory.listsegments
      outputParameters:
      - type: object
        mapping: $.
    - name: getsegment
      description: Get a segment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fullstory.getsegment
      outputParameters:
      - type: object
        mapping: $.
    - name: createsegmentexport
      description: Create a segment export
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fullstory.createsegmentexport
      outputParameters:
      - type: object
        mapping: $.
    - name: getoperationstatus
      description: Get operation status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fullstory.getoperationstatus
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    FULLSTORY_USERNAME: FULLSTORY_USERNAME
    FULLSTORY_PASSWORD: FULLSTORY_PASSWORD