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

# Get Segment Export

> Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of the export

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| AsyncExportNotInFlight | 10011 |
| AsyncExportRateLimitExceeded | 10013 |
| ExportNotFound | 5004 |
| ExportUnknownError | 5013 |
| InvalidSegment | 1242 |
| ProductDisabledForTitle | 1609 |




## OpenAPI

````yaml post /Admin/GetSegmentExport
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Admin API
  description: >-
    APIs for managing title configurations, uploaded Game Server code
    executables, and user data
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Account Management
    description: Account Management APIs
  - name: Authentication
    description: Authentication APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Custom Server Management
    description: Custom Server Management APIs
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Player Data Management
    description: Player Data Management APIs
  - name: Player Item Management
    description: Player Item Management APIs
  - name: PlayStream
    description: PlayStream Management APIs
  - name: ScheduledTask
    description: Task management APIs
  - name: Segments
    description: Segment management APIs
  - name: Server-Side Cloud Script
    description: Server-Side Cloud Script APIs
  - name: Shared Group Data
    description: Shared Group Data APIs
  - name: Title-Wide Data Management
    description: Title-Wide Data Management APIs
  - name: Xbox Store
    description: Xbox Store APIs
paths:
  /Admin/GetSegmentExport:
    post:
      tags:
        - PlayStream
      summary: Get Segment Export
      description: >
        Retrieves the result of an export started by ExportPlayersInSegment API.
        If the ExportPlayersInSegment is successful and complete, this API
        returns the IndexUrl from which the index file can be downloaded. The
        index file has a list of urls from which the files containing the player
        profile data can be downloaded. Otherwise, it returns the current
        'State' of the export


        ## Error codes


        This operation may return the following PlayFab errors:


        | Error | Code |

        | --- | --- |

        | AsyncExportNotInFlight | 10011 |

        | AsyncExportRateLimitExceeded | 10013 |

        | ExportNotFound | 5004 |

        | ExportUnknownError | 5013 |

        | InvalidSegment | 1242 |

        | ProductDisabledForTitle | 1609 |
      operationId: GetSegmentExport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPlayersInSegmentExportRequest'
        description: Request must contain the ExportId
      responses:
        '200':
          $ref: '#/components/responses/GetPlayersInSegmentExportResponse'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  schemas:
    GetPlayersInSegmentExportRequest:
      description: Request must contain the ExportId
      type: object
      properties:
        ExportId:
          description: Unique identifier of the export for the requested Segment.
          type: string
      required:
        - ExportId
      example:
        ExportId: ABCDEF1234567890
    GetPlayersInSegmentExportResponse:
      type: object
      properties:
        IndexUrl:
          description: Url from which the index file can be downloaded.
          type: string
        State:
          description: Shows the current status of the export
          type: string
      example:
        IndexUrl: >-
          https://playfabplayerexports.blob.core.windows.net/titleexportabc/index.txt
        State: Complete
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
  responses:
    GetPlayersInSegmentExportResponse:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/GetPlayersInSegmentExportResponse'
            example:
              code: 200
              status: OK
              data:
                IndexUrl: >-
                  https://playfabplayerexports.blob.core.windows.net/titleexportabc/index.txt
                State: Complete
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  securitySchemes:
    SecretKey:
      type: apiKey
      in: header
      name: X-SecretKey
      description: >-
        This API requires a title secret key, available to title admins, from
        PlayFab Game Manager.

````

## Related topics

- [Get Segment Export](/services/playfab/api-references/rest/server/play-stream/get-segment-export.md)
- [Tutorial to export players in a Segment](/services/playfab/live-service-management/game-configuration/segmentation/segmentation-export-players-in-a-segment.md)
- [PFSegmentsServerGetAllSegmentsAsync](/services/playfab/api-references/c/pfsegments/functions/pfsegmentsservergetallsegmentsasync.md)
- [Tutorial to Count Players of a Segment](/services/playfab/live-service-management/game-configuration/segmentation/segmentation-player-count.md)
- [PlayFab Services SDK Release Notes 2026](/services/playfab/release-notes/index.md)
