> ## 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 Player Count

> Returns the total number of players in a given segment.

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| GetSegmentPlayerCountNotInFlight | 10016 |
| GetSegmentPlayerCountRateLimitExceeded | 10017 |
| InternalServerError | 1110 |
| InvalidSegment | 1242 |
| ProductDisabledForTitle | 1609 |
| SegmentNotFound | 1220 |




## OpenAPI

````yaml post /Admin/GetSegmentPlayerCount
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/GetSegmentPlayerCount:
    post:
      tags:
        - PlayStream
      summary: Get Segment Player Count
      description: |
        Returns the total number of players in a given segment.

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | GetSegmentPlayerCountNotInFlight | 10016 |
        | GetSegmentPlayerCountRateLimitExceeded | 10017 |
        | InternalServerError | 1110 |
        | InvalidSegment | 1242 |
        | ProductDisabledForTitle | 1609 |
        | SegmentNotFound | 1220 |
      operationId: GetSegmentPlayerCount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSegmentPlayerCountRequest'
        description: Request must contain a valid Segment ID.
      responses:
        '200':
          $ref: '#/components/responses/GetSegmentPlayerCountResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  schemas:
    GetSegmentPlayerCountRequest:
      description: Request must contain a valid Segment ID.
      type: object
      properties:
        SegmentId:
          description: Unique identifier for the requested segment.
          type: string
      required:
        - SegmentId
      example:
        SegmentId: 1337AA00
    GetSegmentPlayerCountResult:
      type: object
      properties:
        ProfilesInSegment:
          description: Count of profiles matching this segment.
          type: number
          x-actualtype: int32
      required:
        - ProfilesInSegment
      example:
        ProfilesInSegment: 15
    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:
    GetSegmentPlayerCountResult:
      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/GetSegmentPlayerCountResult'
            example:
              code: 200
              status: OK
              data:
                ProfilesInSegment: 15
    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 Player Count](/services/playfab/api-references/rest/server/play-stream/get-segment-player-count.md)
- [Tutorial to Count Players of a Segment](/services/playfab/live-service-management/game-configuration/segmentation/segmentation-player-count.md)
- [PFSegmentsGetPlayerSegmentsResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayersegmentsresult.md)
- [PFSegmentsGetPlayersSegmentsRequest](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayerssegmentsrequest.md)
- [PFSegmentsGetPlayerTagsResult](/services/playfab/api-references/c/pfsegmentstypes/structs/pfsegmentsgetplayertagsresult.md)