N O T I C E
MSPbots WIKI is moving to a new home at support.mspbots.ai to give you the best experience in browsing our Knowledge Base resources and addressing your concerns. Click here for more info!
Page History
...
Enable Public API Switch
...
The Enable Public API switch feature is the global switch that controls the availability of the Public API feature. The . To activate, switch the Enable Public API toggle ON. If disabled, the API Keys and all connected data will not be available if this switch is OFF or disabledbe inaccessible.
Summary
...
- Public API provides an HTTP-based API that follows the principles of REST.
- The HTTP rules allow the use of simple HTTP clients like cURL.
- The URLs are resource-oriented, the request format is form-encoded, and the responses are JSON.
- All operations are read-only.
...
curl https://api.mspbots.ai/api/widget/{resourceId} -H 'apikey: {apiKey}' -X GET
REQUEST
RESPONSE
Supported query criteria
(Please Note: Currently, widgets that include measure or calculate layers are not supported.)
...
https://api.mspbots.ai/api/widget/{resourceId}?current=1&size=10&Real Name=n&Update Date=2021-10-10,2023-03-30,2023-04-05&Id=,1534956341424005122
Logical Operators | Field Type | example | ||||
TEXT | NUMBER | BOOLEAN | DATE | DATETIME | ||
Is Empty | √ | √ | √ | √ | √ | status= |
Contains | √ | name=Tod | ||||
Equals | √ | √ | is_default=true id=654321324612312 | |||
Later Than (>=) | √ | √ | √ | price=12.6, date=2022-07-01 | ||
Earlier Than (<=) | √ | price=,56.3 | ||||
between (>= and <=) | √ | √ | √ | price=12.6,56.3 date=2022-07-01,2023-02-01 | ||
Multiple intervals (>= and <=) or (>= and <=) | √ | √ | √ | price=12.6,56.3,103,210 date=2022-07-01,2023-02-01,2023-04-01,2023-05-01 | ||
(>= and <=) or (=) | √ | price=12.6,56.3,105.1 | ||||
(>= and <=) or (>=) | √ | √ | date=2022-07-01,2023-02-01,2023-04-01 |
Sample Error Responses
...
- Rate limits
- Invalid apiKey: Error or deleted
- Resource unbound
- The resource does not exist
- HTTP 502 error status code, please refer to Receiving HTTP 502 Error Status Code When Fetching Data Requests from Widget Using Public API for resolution.
Related Topics
...
Content by Label showLabels false showSpace false excludeCurrent true cql label = "public"
Overview
Content Tools