Skip to main content

Get Failed Data

POST https://link.monoz.io/api/v1/{Org-Id}/FailedData

This API is available only for users with the database feature. When database is enabled, monoZ:Link store the data whose data push was failed due to various reasons under FAILED DATA. This Failed data can be retrieved using the GET FAILED Data API. Users must ensure that the data is retrieved using start and end timestamp and it is important to call this API in a way to avoid getting the same data packets repeatedly. We recommend usage of this API once in 4hours upto once per day depending on the incoming data frequency. Note that monoZ:Link stores the data in a NoSQL database, hence standard RDBMS query techniques might not apply.

Args​
ORG-ID
The unique ID assigned to your organisation
StartTime
Starting time in ISO:8601 format
EndTime
End time in ISO:8601 format

Response​
200
Success FetchSuccess
Response Body​

Error   boolean

Indicates if there was an error.

Message   string

Message indicating the result of the operation.

StatusCode   integer

HTTP status code of the response.

Data   array

Array of JSON objects containing failed data details.

Timestamp   timestamp

The received timestamp in ISO:8601 format.

Payload   string

The actual packet received.

ICCID   string

The ICCID of the SIM.

Topic   string

The topic on which the payload was sent.

401
Unauthorized If the API Key is wrong or there is no permission to access the requested data.
400
Bad Request If the input value is not in the correct format.
500
Server Error As described in the Message field.
cURL​
    curl --location 'https://link.monoz.io/api/v1/mti/FailedData' \
    --header 'Content-Type: application/json' \
    --header 'X-API-Key: 3fa36b0e-c88b-45f4-95b9-d77c0e27c07a' \
    --data '{
        "StartTime": "2024-02-11T07:26:54.441Z",
        "EndTime": "2024-03-11T07:26:54.441Z"
    }'
Response​
{
    "Error": false,
    "Message": "FetchSuccess",
    "StatusCode": 200,
    "Data": [
        {
            "Timestamp": "2024-03-11T04:19:55.5799558Z",
            "Payload": "DFa0FC31EEC1569aA274f9ae5fffbB80AE2691BEe4EDBC89F6",
            "ICCID": "123456789",
            "Topic": "The topic on which the payload was received at monoZ:Link."
        }
    ]
}