Last updated

API Changelog

Our changelog documents all changes to our API and core functionality.

January 8, 2024 - System Labels, User Tags, Meta Hits

Added

The following fields were added to the Search API:

  • meta: Contains meta information about the scan and matched searches, e.g., the IDs of Saved Searches that this item has matched.

The following fields were added to the Result API:

  • metatags: Contains meta information about the scan and matched searches, e.g., the IDs of Saved Searches that this item has matched.

The following fields were added to the Result API and Search API output:

  • labels: Contains system labels controlled by urlscan.
  • usertags: Contains user-defined tags applied by Saved Searches.
  • page.apexDomain: The registered second-level domain of the page hostname
  • page.mimeType: Page MIME type
  • page.redirected: Whether the page was redirected
  • page.status: HTTP response code for primary page
  • page.title: Title of the website
  • page.tlsAgeDays: Age of the TLS certificate at the time of scanning
  • page.tlsIssuer: TLS issuer name for the TLS cert of the page
  • page.tlsValidDays: Validity period of the TLS certificate in days
  • page.tlsValidFrom: ISO 8601 timestamp of valid-from date for page TLS certificate
  • page.umbrellaRank: Cisco Umbrella rank of the page hostname
  • task.apexDomain: The registered second-level domain of the task hostname

April 20, 2022 - Result API Warnings

Changed

  • verdicts.XXX.score: This is an integer now which can range from -100 (legitimate) to 100 (malicious). Previously the range was 0-100.
  • verdicts.overall.brands: This is a flat array of brand identifiers, contrary to verdicts.urlscan.brands which is an array of objects.

Removed

  • verdicts.engines: This field is not used anymore and should not be relied on.

Warnings

  • Attention: Make sure your response parser can handle missing fields.
  • Attention: If you use any of the detailed fields from the API result (especially within the data.requests list) then be prepared to adjust your code when data fields and formats change, or fields are added or removed. Many fields are not generated by us but by the Google Chrome webbrowser and as such may change over time without our intervention.