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

# api_rate_limit_alert

> Preview PlayFab event raised when an API caller approaches or reaches a rate limit, with properties for the API, caller entity, and limit crossings.

> [!NOTE]
>
> This event is in preview. Its payload, behavior, and availability might change.

This event can be triggered when an API caller approaches or reaches a rate limit. A warning is currently raised at 80% of the limit, but this threshold, like other details of the event, might change. An alert is raised the first time usage crosses the warning threshold (`Warning`) or the limit itself (`HardLimit`) within a tracking period, not on every call after that. To tell whether calls are being throttled, use HTTP 429 responses. You can query it in Game Manager **Data Explorer**. For more information about rate limits, see [Throttling in PlayFab](https://docs.xbox.com/services/playfab/live-service-management/service-gateway/throttling/what-is-throttling.md).

## Properties

| Name | Type | Description |
| :- | :- | :- |
| API | String | The PlayFab API that was called. For example, `client/gettime`. |
| CallerEntityType | String | The type of entity that made the call. For example, `title_player_account` or `title`. |
| CallerEntityId | String | The ID of the entity that made the call. Might be omitted or masked. |
| Crossings | object\[] | The rate limits that the call approached or reached. In each entry, `CrossingType` is `Warning` when a limit is being approached or `HardLimit` when it's reached, and `LimitKind`, `TrackingPeriod`, and `Limit` describe the limit. Entries for limits on a target entity also include `TargetEntityType` and `TargetEntityId`, and that ID might be omitted or masked. |

## Common properties

All V2 PlayStream events are formatted as JSON objects and most share the following common properties:

| Name | Type | Description |
| :- | :- | :- |
| SchemaVersion | String | PlayStream event format version, following a semantic versioning scheme. |
| FullName | [Object](https://docs.xbox.com/services/playfab/api-references/events/data-types/fullnameobject.md) | Combination of the event name and event namespace to fully specify the event type. |
| Id | String | PlayFab-assigned unique identifier for this event. |
| Timestamp | DateTime | The time (in UTC) associated with this event. |
| Entity | [Object](https://docs.xbox.com/services/playfab/api-references/events/data-types/entityobject.md) | Details about the entity to which this event applies including Entity Id and Entity type. |
| Originator | [Object](https://docs.xbox.com/services/playfab/api-references/events/data-types/originatorobject.md) | Object describing the source and source type that initiated this event. |
| PayloadContentType | String | Specifies the content of the event payload. Default is "JSON". |
| Origin Info | Object | Optional field containing info about events originating outside of PlayFab. |


## Related topics

- [PlayStream Event Model reference](https://docs.xbox.com/services/playfab/api-references/events/index.md)
- [Throttling best practices and recommendations](https://docs.xbox.com/services/playfab/live-service-management/service-gateway/throttling/best-practices.md)
- [Throttling in PlayFab](https://docs.xbox.com/services/playfab/live-service-management/service-gateway/throttling/what-is-throttling.md)
- [title_client_rate_limited_alert](https://docs.xbox.com/services/playfab/api-references/events/Title/title-client-rate-limited-alert.md)
- [title_high_error_rate_alert](https://docs.xbox.com/services/playfab/api-references/events/Title/title-high-error-rate-alert.md)