[GET] - View Subscription Alerts by fields or Agents

Follow

Use this API to view the subscription alert details by fields.

Endpoint

GET https://api.insideview.com/api/v1/subscription/{{subscriptionId}}/alert/{{alertId}}/fields

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

Company

{
  "companyAlertDetails": [
    {
      "companyId": "1",
      "fields": [
        "name"
      ]
    }
  ],
  "subscriptionType": "company",
  "page": 1,
  "resultsPerPage": 5000,
  "totalResults": 1
}

Company News

{
  "companyNewsAlertDetails": [
    {
      "companyId": "643462",
      "articleId": "VdNBNyRGnBUjJ8P65DG6dtw_KKrp-UhBbmL4JSqDA65S1rCXr2IQ5zvKc4aqhj4NooM8hXAnuM5-lDVoZMxrXQ",
      "timestamp": "2016-03-04T18:36:46.384Z"
    }
  ],
  "subscriptionType": "companynews",
  "page": 1,
  "resultsPerPage": 5000,
  "totalResults": 1
}

People

{
  "peopleAlertDetails": [
    {
      "peopleId": "z-uKy8gWd3h_nLGWvxjkFQEo2UNJSSaxv5WYWmEuk460lsHL9Ltr55ggKIi8g4Zp",
      "fields": [
        "linkedInHandle"
      ],
      "employments": [
        {
          "contactId": "48",
          "fields": [
            "titles",
            "salary"
          ]
        },
        {
          "contactId": "323",
          "fields": [
            "age"
          ]
        }
      ]
    }
  ],
  "subscriptionType": "people",
  "page": 1,
  "resultsPerPage": 5000,
  "totalResults": 50
}

HTTP Error Codes

If invalid AlertId is specified

{
    "errorType": "VALIDATION_ERROR",
    "status": 400,
    "message": "Invalid Alert ID",
    "diagnosticCode": "q6unkkacr7u57i17jup8",
    "errorNumber": "400-1510"
}
Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk