Versions Compared

Key

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

...

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

...