Re: GraphQL Admin API - example Throttled request's response

Solved

GraphQL Admin API - example Throttled request's response

LiveChatInc
Shopify Partner
10 0 5

Hello, fellow devs! I'm working on GraphQL Admin API Rate Limit, and the documentation mentions as below:

 

All requests that are made after the limit has been exceeded are throttled and an {errors: [{ message: "Throttled" }]} error is returned.

Does any of you could share an example response from the request that was throttled? It's hard for me to exceed the limits as our dev stores do not have enough data (i.e., orders or customers). I'm especially looking for a response body, and status code returned in case of exceeding API limits.

Accepted Solution (1)
AddisonApps
Shopify Partner
56 6 14

This is an accepted solution.

Here is an example of a throttled request:

{
   "errors":[
      {
         "message":"Throttled"
      }
   ],
   "extensions":{
      "cost":{
         "requestedQueryCost":202,
         "actualQueryCost":null,
         "throttleStatus":{
            "maximumAvailable":1000.0,
            "currentlyAvailable":118,
            "restoreRate":50.0
         }
      }
   }
}

View solution in original post

Replies 6 (6)

AddisonApps
Shopify Partner
56 6 14

The status code returned on throttled request should be 429.

LiveChatInc
Shopify Partner
10 0 5

For sure it's 429 for Admin REST API, but the documentation doesn't mention if it's true for GraphQL API too. Thanks anyway @AddisonApps 🙂

AddisonApps
Shopify Partner
56 6 14

This is an accepted solution.

Here is an example of a throttled request:

{
   "errors":[
      {
         "message":"Throttled"
      }
   ],
   "extensions":{
      "cost":{
         "requestedQueryCost":202,
         "actualQueryCost":null,
         "throttleStatus":{
            "maximumAvailable":1000.0,
            "currentlyAvailable":118,
            "restoreRate":50.0
         }
      }
   }
}
LiveChatInc
Shopify Partner
10 0 5

Thanks a ton, @AddisonApps!

Denedric_McCull
Visitor
2 0 0

I am having a throttled error when attempting to add photos to products. Please help.

cmayer
Shopify Partner
1 0 0

Is the "extensions" object indeed outside of "errors"? The documentation makes it looks like it should be within the error object. Can you confirm or have the documentation updated? Thanks

https://shopify.dev/api/admin-graphql#status_and_error_codes