PlayFab Insights API

openapi: 3.0.3
info:
  version: '260922'
  title: PlayFab Insights API
  description: Manage the Insights performance level and data storage retention settings.
  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
  variables:
    titleId:
      default: titleId
      description: Unique PlayFab title identifier.
tags:
- name: Analytics
  description: Analytics APIs
paths:
  /Insights/GetDetails:
    post:
      operationId: GetDetails
      tags:
      - Analytics
      description: Gets the current values for the Insights performance and data storage retention, list of pending operations, and the performance
        and data storage retention limits.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails
      security:
      - EntityToken: []
      parameters:
      - type: object
        description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves;
          the shape is unknown and is NOT a claim about the API.
        x-ae-placeholder: true
      responses:
        '200':
          description: ''
        '400':
          description: ''
  /Insights/GetLimits:
    post:
      operationId: GetLimits
      tags:
      - Analytics
      description: Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details for
        each performance level.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits
      security:
      - EntityToken: []
      parameters:
      - type: object
        description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves;
          the shape is unknown and is NOT a claim about the API.
        x-ae-placeholder: true
      responses:
        '200':
          description: ''
        '400':
          description: ''
  /Insights/GetOperationStatus:
    post:
      operationId: GetOperationStatus
      tags:
      - Analytics
      description: Gets the status of a SetPerformance or SetStorageRetention operation.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus
      security:
      - EntityToken: []
      x-ms-docs-errors:
      - InsightsManagementGetOperationStatusInvalidParameter
      - InsightsManagementOperationNotFound
      parameters:
      - type: object
        description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves;
          the shape is unknown and is NOT a claim about the API.
        x-ae-placeholder: true
      responses:
        '200':
          description: ''
        '400':
          description: ''
  /Insights/GetPendingOperations:
    post:
      operationId: GetPendingOperations
      tags:
      - Analytics
      description: Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations
      security:
      - EntityToken: []
      parameters:
      - type: object
        description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves;
          the shape is unknown and is NOT a claim about the API.
        x-ae-placeholder: true
      responses:
        '200':
          description: ''
        '400':
          description: ''
  /Insights/SetPerformance:
    post:
      operationId: SetPerformance
      tags:
      - Analytics
      description: Sets the Insights performance level value for the title.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance
      security:
      - EntityToken: []
      x-ms-docs-errors:
      - InsightsManagementDatabaseNotFound
      - InsightsManagementErrorPendingOperationExists
      - InsightsManagementSetPerformanceLevelInvalidParameter
      - PaidInsightsFeaturesNotEnabled
      - TitleNotOnUpdatedPricingPlan
      parameters:
      - type: object
        description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves;
          the shape is unknown and is NOT a claim about the API.
        x-ae-placeholder: true
      responses:
        '200':
          description: ''
        '400':
          description: ''
  /Insights/SetStorageRetention:
    post:
      operationId: SetStorageRetention
      tags:
      - Analytics
      description: Sets the Insights data storage retention days value for the title.
      externalDocs:
        url: https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention
      security:
      - EntityToken: []
      x-ms-docs-errors:
      - InsightsManagementDatabaseNotFound
      - InsightsManagementErrorPendingOperationExists
      - InsightsManagementSetStorageRetentionAboveMaximum
      - InsightsManagementSetStorageRetentionBelowMinimum
      - InsightsManagementSetStorageRetentionInvalidParameter
      - PaidInsightsFeaturesNotEnabled
      - TelemetryKeyLongInsightsRetentionNotAllowed
      - TitleNotOnUpdatedPricingPlan
      parameters:
      - type: object
        description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves;
          the shape is unknown and is NOT a claim about the API.
        x-ae-placeholder: true
      responses:
        '200':
          description: ''
        '400':
          description: ''
components:
  schemas:
    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
    InsightsEmptyRequest:
      type: object
      properties:
        CustomTags:
          description: The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
          type: object
      example: {}
    InsightsGetDetailsResponse:
      type: object
      properties:
        DataUsageMb:
          description: Amount of data (in MB) currently used by Insights.
          type: number
          x-actualtype: uint32
        ErrorMessage:
          description: Details of any error that occurred while retrieving Insights details.
          type: string
        Limits:
          $ref: '#/components/schemas/InsightsGetLimitsResponse'
          description: Allowed range of values for performance level and data storage retention.
          type: object
          x-isclass: true
        PendingOperations:
          description: List of pending Insights operations for the title.
          type: array
          items:
            $ref: '#/components/schemas/InsightsGetOperationStatusResponse'
          x-isclass: true
        PerformanceLevel:
          description: Current Insights performance level setting.
          type: number
          x-actualtype: int32
        RetentionDays:
          description: Current Insights data storage retention value in days.
          type: number
          x-actualtype: int32
      required:
      - PerformanceLevel
      - RetentionDays
      - DataUsageMb
    InsightsGetLimitsResponse:
      type: object
      properties:
        DefaultPerformanceLevel:
          description: Default Insights performance level.
          type: number
          x-actualtype: int32
        DefaultStorageRetentionDays:
          description: Default Insights data storage retention days.
          type: number
          x-actualtype: int32
        StorageMaxRetentionDays:
          description: Maximum allowed data storage retention days.
          type: number
          x-actualtype: int32
        StorageMinRetentionDays:
          description: Minimum allowed data storage retention days.
          type: number
          x-actualtype: int32
        SubMeters:
          description: List of Insights submeter limits for the allowed performance levels.
          type: array
          items:
            $ref: '#/components/schemas/InsightsPerformanceLevel'
          x-isclass: true
      required:
      - StorageMinRetentionDays
      - StorageMaxRetentionDays
      - DefaultPerformanceLevel
      - DefaultStorageRetentionDays
    InsightsGetOperationStatusRequest:
      description: Returns the current status for the requested operation id.
      type: object
      properties:
        CustomTags:
          description: The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
          type: object
        OperationId:
          description: Id of the Insights operation.
          type: string
      example:
        OperationId: 3ee468c4-ad09-4bb1-bccf-209ef5abfb96
    InsightsGetOperationStatusResponse:
      type: object
      properties:
        Message:
          description: Optional message related to the operation details.
          type: string
        OperationCompletedTime:
          description: Time the operation was completed.
          type: string
        OperationId:
          description: Id of the Insights operation.
          type: string
        OperationLastUpdated:
          description: Time the operation status was last updated.
          type: string
        OperationStartedTime:
          description: Time the operation started.
          type: string
        OperationType:
          description: The type of operation, SetPerformance or SetStorageRetention.
          type: string
        OperationValue:
          description: The value requested for the operation.
          type: number
          x-actualtype: int32
        Status:
          description: Current status of the operation.
          type: string
      required:
      - OperationValue
      - OperationStartedTime
      - OperationLastUpdated
      - OperationCompletedTime
    InsightsGetPendingOperationsRequest:
      description: Returns a list of operations that are in the pending state for the requested operation type.
      type: object
      properties:
        CustomTags:
          description: The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
          type: object
        OperationType:
          description: The type of pending operations requested, or blank for all operation types.
          type: string
      example:
        OperationType: SetPerformance
    InsightsGetPendingOperationsResponse:
      type: object
      properties:
        PendingOperations:
          description: List of pending Insights operations.
          type: array
          items:
            $ref: '#/components/schemas/InsightsGetOperationStatusResponse'
          x-isclass: true
    InsightsOperationResponse:
      type: object
      properties:
        Message:
          description: Optional message related to the operation details.
          type: string
        OperationId:
          description: Id of the Insights operation.
          type: string
        OperationType:
          description: The type of operation, SetPerformance or SetStorageRetention.
          type: string
    InsightsPerformanceLevel:
      type: object
      properties:
        ActiveEventExports:
          description: Number of allowed active event exports. This value is always zero.
          type: number
          x-actualtype: int32
        CacheSizeMB:
          description: Maximum cache size.
          type: number
          x-actualtype: int32
        Concurrency:
          description: Maximum number of concurrent queries.
          type: number
          x-actualtype: int32
        CreditsPerMinute:
          description: Number of Insights credits consumed per minute.
          type: number
          x-actualtype: double
        EventsPerSecond:
          description: Maximum events per second.
          type: number
          x-actualtype: int32
        Level:
          description: Performance level.
          type: number
          x-actualtype: int32
        MaxMemoryPerQueryMB:
          description: Maximum amount of memory allowed per query.
          type: number
          x-actualtype: int32
        VirtualCpuCores:
          description: Amount of compute power allocated for queries and operations.
          type: number
          x-actualtype: int32
      required:
      - Level
      - EventsPerSecond
      - Concurrency
      - MaxMemoryPerQueryMB
      - CacheSizeMB
      - VirtualCpuCores
      - CreditsPerMinute
      - ActiveEventExports
    InsightsSetPerformanceRequest:
      description: Sets the performance level to the requested value. Use the GetLimits method to get the allowed values.
      type: object
      properties:
        CustomTags:
          description: The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
          type: object
        PerformanceLevel:
          description: The Insights performance level to apply to the title.
          type: number
          x-actualtype: int32
      required:
      - PerformanceLevel
      example:
        PerformanceLevel: 3
    InsightsSetStorageRetentionRequest:
      description: Sets the data storage retention to the requested value. Use the GetLimits method to get the range of allowed values.
      type: object
      properties:
        CustomTags:
          description: The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
          type: object
        RetentionDays:
          description: The Insights data storage retention value (in days) to apply to the title.
          type: number
          x-actualtype: int32
      required:
      - RetentionDays
      example:
        RetentionDays: 30
  securitySchemes:
    None:
      type: apiKey
      in: header
      name: None
      description: This API requires no authentication headers (usually provides one to other calls).
    SessionTicket:
      type: apiKey
      in: header
      name: X-Authorization
      description: This API requires a client session ticket, available from any Client Login function.
    SecretKey:
      type: apiKey
      in: header
      name: X-SecretKey
      description: This API requires a title secret key, available to title admins, from PlayFab Game Manager.
    EntityToken:
      type: apiKey
      in: header
      name: X-EntityToken
      description: This API requires an Entity Session Token, available from the Entity GetEntityToken method.
x-source:
  converted-from: https://raw.githubusercontent.com/PlayFab/API_Specs/master/Swagger/PlayFab/Insights.swagger.json
  method: converted swagger 2.0 -> openapi 3.0.3 mechanically
  generated: '2026-11-05'