[GET] - Fetch Subscription Alert

Follow

Use this API to view the subscription alert details. In case you had given a Webhook URL at the time of creating or Updating subscription then alert is sent in below format to that webhook :

{"alertId":"1","subscriptionId":"fpnd60aqje2poh59v2k0","date":"2015-10-07T00:20:04-0700","type":"news"}

Endpoint

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

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

{
  "companyIds": [
    "736233"
  ],
  "subscriptionType": "company",
  "page": 1,
  "resultsPerPage": 5000,
  "totalResults": 1
}

Company News

{
  "companyIds": [
    "736233"
  ],
  "subscriptionType": "companyNews",
  "page": 1,
  "resultsPerPage": 5000,
  "totalResults": 1
}

People

{
  "peopleIds": [
    "IDivDfKDNZlvpSQVZ2EixDo4Bm8IAk46feeac_FuSF6UwSLVRbiNE-0NKwWU1QLx"
  ],
  "subscriptionType": "people",
  "page": 1,
  "resultsPerPage": 5000,
  "totalResults": 1
}

Company Family Tree

Case 1 : New companies got added to Family Tree

{
    "companyFamilyTreeAlertDetails": [
        {
            "companyId": 815338,
            "companyFamilyTreeChanges": {
                "addedCompanies": [
                    789282
                ]
            }
        }
    ],
    "subscriptionType": "companyfamilytree",
    "page": 1,
    "resultsPerPage": 5000,
    "totalResults": 1
}

Case 2 : Companies got deleted from Family Tree

{
    "companyFamilyTreeAlertDetails": [
        {
            "companyId": 731713,
            "companyFamilyTreeChanges": {
                "deletedCompanies": [
                    789282
                ]
            }
        }
    ],
    "subscriptionType": "companyfamilytree",
    "page": 1,
    "resultsPerPage": 5000,
    "totalResults": 1
}
 

Case 3 : Companies got added and Deleted from Family Tree

{
    "companyFamilyTreeAlertDetails": [
        {
            "companyId": 1001632,
            "companyFamilyTreeChanges": {
                "addedCompanies": [
                    123456,
                    1234567
                ],
                "deletedCompanies": [
                    123456,
                    1234567
                ]
            }
        }
    ],
    "subscriptionType": "companyfamilytree",
    "page": 1,
    "resultsPerPage": 5000,
    "totalResults": 1
}

 

Case 4 : when subscribed ultimate parent companyId itself is acquired

{
    "companyFamilyTreeAlertDetails": [
        {
            "companyId": 781163,
            "message": "Subscription updated from 781163 to 726263",
            "companyFamilyTreeChanges": {
                "addedCompanies": [
                    963086,
                    1069587,
                    1193495,
                    15285475,
                    56843,
                    1985040,
                    1338907,
                    2811963,
                    1470464
               ],
                "newUltimateParentCompanyId": 726263
            }
        }
    ],
    "subscriptionType": "companyfamilytree",
    "page": 1,
    "resultsPerPage": 5000,
    "totalResults": 1
}
 

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