Performance Guidelines

These guidelines provide publishers with performance benchmarks for Entitlement APIs, ensuring consistent service quality for GetFTR participants.

Occasional failures to meet recommended performance standards may result in publisher responses not being served through GetFTR and subsequently not surfaced on integrator platforms. Such scenarios will be managed gracefully by GetFTR and integrators. Persistent performance issues may lead to suspension from GetFTR. Publishers will be notified in advance to resolve performance issues.

Load Profile

GetFTR will advise publishers regarding expected load and peak usage. Publishers can opt to either rate-limit or scale to handle higher peak loads while maintaining service quality. Publishers must declare rate limits to GetFTR during onboarding. GetFTR blocks inbound DDoS attacks, ensuring they are not passed onto publisher APIs.

Average Response Time (ART)

A recommended average response time of 300ms over a one-month reporting period, as observed at the endpoint location.

Percentile Response Time (PART)

A recommended response time of 500ms at the 95th percentile over a one-month reporting period, as observed at the endpoint location.

Uptime (UT)

A recommended uptime of 99.8% over a one-month reporting period. Periods identified as API faults below count as downtime.

Timeouts

GetFTR will time out & close API connections and requests exceeding one second, as observed at GetFTR. Refer to API Faults below.

Monitoring

Publishers must monitor the performance of their APIs and promptly resolve any issues to restore entitlements. To minimize maintenance overhead, GetFTR does not raise or pursue publisher support tickets on behalf of publishers.

API Faults

The following scenarios classify as API faults: - API timing out (exceeding one-second response time as observed by GetFTR) - /status endpoint indicating service disruption - 5xx HTTP response status codes - API in maintenance mode (GetFTR does not distinguish between types of maintenance)

Circuit Breaker

GetFTR recommends publishers implement a Circuit Breaker pattern in their API implementation, ensuring rapid failure responses and resource conservation during recovery attempts.