get https://{shopdomain}.myshoplaza.com/openapi/2022-01/app-proxies/count
Requires
read_app_proxyaccess scope.
The App Proxy Count API retrieves the total number of APP_Proxy instances created by the current application for the current store. This is useful for auditing the number of active proxy configurations set up by a specific app.
This API is especially useful for:
- Monitoring the number of app proxy integrations for a given application.
- Assessing the scalability of app proxy setups for a store.
- Ensuring the application does not exceed its proxy limits.
Request Parameters
Public Request Parameters
Response Explanation
Public Response Parameters
Successful Response Fields
| Field | Type | Description | Example |
|---|---|---|---|
count | int | The total number of APP_Proxy instances. | 1 |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |