[GET] - View Subscription Alerts

Follow

Use this API allows to view all alerts of a particular subscription. Most recent Alert IDs are displayed at the top.

Endpoint

GET https://api.insideview.com/api/v1/subscription/{{subscriptionId}}/alerts

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes

Valid access token.
See Authentication and Authorization Overview for more details.

Accept String No Selects the response's content type.  
Valid values are application/json and application/xml (default)

Responses

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header. 

Name type Description
alerts Array List of alerts
alerts > alertId Integer  Alert ID
alerts > createdDate String Alert generation date

application/json example

{
  "alerts": [
    {
      "alertId": 107,
      "createdDate": "2015-08-12T00:15:52.000-07:00"
    },
    {
      "alertId": 78,
      "createdDate": "2015-08-04T00:11:56.000-07:00"
    },
    {
      "alertId": 75,
      "createdDate": "2015-07-31T00:19:07.000-07:00"
    }
  ]
}
    

application/xml example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Alert>
    <alerts>
        <alert>
            <alertId>107</alertId>
            <createdDate>2015-08-12T00:15:52.000-07:00</createdDate>
        </alert>
        <alert>
            <alertId>78</alertId>
            <createdDate>2015-08-04T00:11:56.000-07:00</createdDate>
        </alert>
        <alert>
            <alertId>75</alertId>
            <createdDate>2015-07-31T00:19:07.000-07:00</createdDate>
        </alert>
    </alerts>
</Alert>

HTTP 401

Unauthorized Error - Cannot use API's without setting a valid accessToken in header.

HTTP 405

Method Not Allowed - Your are not allowed to access this API.

HTTP 404

Invalid subscription ID, record not found.

HTTP 429

Request is throttled.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk