GET /page/classify

The page classification endpoint is /page/classify.

1 Example
- 1.1 Request
- 1.2 Response
2 Request Format
3 Header
4 Query Parameters
5 Responses

Example

Request

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>

Response

{
  "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 https://gumgum.jira.com/wiki/spaces/VDC/pages/1712095256 for an example page analysis request.

Header

Field	Type	Description	Optional/Required

Field	Type	Description	Optional/Required
`x-api-key`	String	GumGum authentication token.	Required

Query Parameters

Parameter name	Type	Description	Optional/Required

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:

Once the request status is PROCESSED, the complete JSON page analysis response is returned. Refer to https://gumgum.jira.com/wiki/spaces/VDC/pages/1780154512 for details.