Versions Compared

Old Version 9

changes.mady.by.user ClaireT

Saved on

compared with

New Version Current

changes.mady.by.user ClaireT

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

The page classification endpoint is /page/classify.

Table of Contents

Verity 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.

  • Any request parameter values must be properly URL-encoded.

See Get Started - Page API for an example page analysis request.

Example Request

curl -H

Example

Request

Code Block
curl -H 'x-api-key: <YOUR_API_KEY_HERE>’ <https://verity-api.gumgum.com/page/classify?pageUrl=https%3A%2F%2Faragonresearch.com%2Fcisco-google-and-zoom-enhance-free-meetings-to-assist-with-coronavirus%2F>
Example

Response

Code Block
languagejson
{
    "dataAvailable" : false,
    "status" : "INITIATED",
    "pageUrl" : "https://aragonresearch.com/cisco-google-and-zoom-enhance-free-meetings-to-assist-with-coronavirus/",
  "uuid": "deb59fc2-b8ef-4dbe-ab64-6a1950a45a76"
}

Request Format

Verity 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.

  • Any request parameter values must be properly URL-encoded.

See Get Started - Page API for an example page analysis request.

Header 

Field

Type

Description

Optional/Required

x-api-key

String

GumGum authentication token.

Required

Query Parameters

Parameter name

Type

Description

Optional/Required

pageURL

String

URL of page to be analyzed. Must be properly URL-encoded. 

Required

callBackUrl

String

URL to return response. Must be properly URL-encoded.
 

 

Optional
Note: If using a webhook, callBackUrl is required.

ignoreCache

Boolean

To reprocess a page immediately,  and bypass a stored response, append ignoreCache=true to the end of a GET request. The value defaults to false. 

Optional

Responses

JSON responses are returned with the format Content-Type: application/json; charset=UTF-8  showing the current request status: 

Include Page
Page Application Status Messages
Page Application Status Messages

Once the request status is PROCESSED, the complete JSON page analysis response is returned. Refer to Page JSON Response for details.