NOnotte
Data APIs

Extract a website styleguide

Changed on
get/data/web/styleguide

Request

  • Base URL
    https://api.notte.cc (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: token

Query parameters

domainstring nullable
directUrlstring nullable
maxAgeMsinteger nullable
colorSchemestring
timeoutOpts[milliseconds]integer nullable
timeoutOpts[behavior]string
zdrstring
tagsstring nullable

Headers

X-Notte-Cache-Modestring nullable

Extraction cache: default, refresh, or bypass.

X-Notte-Cache-Max-Age-Msstring nullable

Maximum cached result age in milliseconds; zero forces refresh.

X-Notte-Cache-Ttl-Secondsstring nullable

Shorten the server storage TTL; zero bypasses caching.

x-notte-request-originstring nullable
x-notte-sdk-versionstring nullable

Response

Successful Response

status'ok' required
domainstring required
codeinteger required
finalDOMState'loaded' | 'still-loading' required
request_idstring required

Changes

  • 20f8ac8dc733Revision changes
    • breaking

      the response property const value miss was removed for the status

    • warning

      added the new hit enum value to the / response property for the response status

    • warning

      added the new miss enum value to the / response property for the response status

    • info

      added the new optional header request parameter X-Notte-Cache-Max-Age-Ms

    • info

      added the new optional header request parameter X-Notte-Cache-Mode

    • info

      added the new optional header request parameter X-Notte-Cache-Ttl-Seconds

  • 24d67222f012Revision changes
    • info

      endpoint added