{ "uuid": "d91add9e-7c09-43fb-8b5e-09f945597901", "lastMigration": 29, "name": "Progress to Rate Limit API", "endpointPrefix": "developer/analytics/v1_beta", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "85644160-af41-44ae-82f7-b30418eaf046", "documentation": "This method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and resources. The response from getRateLimits includes a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. By default, this method returns utilization data for all RESTful API resources. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see Compatible Application Check.", "method": "get", "endpoint": "rate_limit/", "responses": [ { "uuid": "784f0bd5-bdad-4acb-a8b8-f873cb14c556", "body": "{\n \"rateLimits\": [\n {\n \"apiContext\": \"\",\n \"apiName\": \"\",\n \"apiVersion\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"rates\": [\n {\n \"limit\": {{faker 'number.int' max=99999}},\n \"remaining\": {{faker 'number.int' max=99999}},\n \"reset\": \"\",\n \"timeWindow\": {{faker 'number.int' max=99999}}\n }\n ]\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "12bfc4dd-c6e7-457b-b31d-b7bc17789ae8", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "192e13f3-d886-47b5-87ba-2a141e74f02e", "body": "{\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a725237d-d5db-4dbc-9aa1-78769fc129c5", "documentation": "This method retrieves the call limit and utilization data for an application user. The call-limit data is returned for all RESTful APIs and resources that limit calls on a per-user basis. The response from getUserRateLimits includes a list of the applicable resources and the "call limit", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the "time window" to which the quota applies. By default, this method returns utilization data for all RESTful API resources that limit request access by user. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see Compatible Application Check.", "method": "get", "endpoint": "user_rate_limit/", "responses": [ { "uuid": "8208173a-2300-4593-a544-47e4f2a70c9d", "body": "{\n \"rateLimits\": [\n {\n \"apiContext\": \"\",\n \"apiName\": \"\",\n \"apiVersion\": \"\",\n \"resources\": [\n {\n \"name\": \"\",\n \"rates\": [\n {\n \"limit\": {{faker 'number.int' max=99999}},\n \"remaining\": {{faker 'number.int' max=99999}},\n \"reset\": \"\",\n \"timeWindow\": {{faker 'number.int' max=99999}}\n }\n ]\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "313d92d1-8ac9-4f2c-8c15-bd9805c6e911", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f2624555-450a-4b66-8662-592be73d18ae", "body": "{\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "85644160-af41-44ae-82f7-b30418eaf046" }, { "type": "route", "uuid": "a725237d-d5db-4dbc-9aa1-78769fc129c5" } ] }