Table of Contents |
---|
The Verity GumGum Contextual REST API URL is:
Verity GumGum Contextual API processes HTTPS GET requests specifying a properly-formed page URL in the following format:
https://verity-api.gumgum.com/page/classify?pageUrl=<WEBPAGE_URL>
The URL specified in <WEBPAGE_URL> must meet the following requirements:
...
Start with http:// or https://.
...
Have a properly URL-encoded address.
...
HTTP Request | GET |
Authorization Header |
|
GumGum Contextual Endpoint |
|
URL Param |
|
Callback Param |
|
Example Page Request
Classifying the page with the Verity GumGum Contextual API is a simple two-step process. This example shows a request to analyze a web page, including its text and any prominent image detected. The example page URL is:
https://aragonresearch.com/cisco-google-and-zoom-enhance-free-meetings-to-assist-with-coronavirus
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Note: This url will be sent to the endpoint on query param ´pageUrl´. |
Step 1 – Submit a GET page classification request
...
Code Block | ||
---|---|---|
| ||
curl -H 'x-api-key: <YOUR_API_KEY>' 'https://verity-api.gumgum.com/page/classify?pageUrl=<TEST_URL>&callBackUrl=<YOUR_WEBHOOK_URL>' |
Verity GumGum Contextual API returns a JSON response with Content-Type: application/json; charset=UTF-8 showing the request has the following status:
...
Once the status changes to PROCESSED, the JSON page classification results are returned in the response message data payload.Note: You
Alternative Process - Utilizing callBackUrl
Instead of hitting the endpoint and polling for the results, you can also specify a callBackUrl in a GET request. The JSON classification results are then returned only to the callBackUrl, and not the response message data payload. See Integrating a Webhook for an example GET request with a callBackUrl.
...
Code Block | ||
---|---|---|
| ||
{ "dataAvailable": true, "status": "PROCESSED", "pageUrl": "https://aragonresearch.com/cisco-google-and-zoom-enhance-free-meetings-to-assist-with-coronavirus/", "uuid": "5f48fd0e-c352-4b94-802d-fa1d645e3604", "verityData": { "processedAt": "2021-05-28T00:14:48.807Z", "expiresAt": "2021-06-27T00:14:48.807Z", "languageCode": "en", "iab": { "v1": [ { "id": "IAB19", "category": "Technology & Computing", "score": 0.52 }, { "id": "IAB7", "category": "Health & Fitness", "score": 0.13 }, { "id": "IAB19-18", "category": "Internet Technology", "score": 0.11 }, { "id": "IAB19-8", "category": "Computer Networking", "score": 0.1 }, { "id": "IAB7-37", "category": "Psychology/Psychiatry", "score": 0.09 } ], "v2": [ { "id": "596", "category": "Technology & Computing", "score": 0.56 }, { "id": "379", "category": "News and Politics", "score": 0.16 }, { "id": "600", "category": "Computer Networking", "score": 0.08, "parent": { "id": "599", "category": "Computing", "parent": { "id": "596", "category": "Technology & Computing" } } }, { "id": "635", "category": "Smartphones", "score": 0.07, "parent": { "id": "632", "category": "Consumer Electronics", "parent": { "id": "596", "category": "Technology & Computing" } } }, { "id": "388", "category": "Political Issues", "score": 0.07, "parent": { "id": "386", "category": "Politics", "parent": { "id": "379", "category": "News and Politics" } } } ] }, "keywords": [ "coronavirus", "covid-19", "pandemic", "cisco", "zoom", "free meetings", "google", "logmein", "web", "video conferencing market", "collaboration", "companies", "video meetings", "china", "larger organizations", "webex video conferencing technology", "free remote work kits", "countries" ], "safe": false, "threats": [ { "id": "GGT9", "category": "Medical", "confidence": "VERY_HIGH", "risk": "HIGH" } ], "events": [], "sentiments": [ { "sentiment": "neutral", "score": 0.73 }, { "sentiment": "positive", "score": 0.24 }, { "sentiment": "negative", "score": 0.03 } ] } } |
More Information
Child pages |
---|
...