Web Extraction

Classify NAICS codes

Changed on

Classify a company into NAICS industry codes.

get/web/naics

Request

  • Base URL: https://api.context.dev/v1
  • URL: https://api.context.dev/v1/web/naics
  • Auth: HTTP bearer

Query parameters

inputstring required

Brand domain or title to retrieve NAICS code for. If a valid domain is provided, it will be used for classification, otherwise, we will search for the brand using the provided title.

minResultsinteger

Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.

maxResultsinteger

Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults to 5.

millisecondsinteger required

Deadline in milliseconds.

behavior'fail' | 'return-partial'

"fail" returns 408 at the deadline. "return-partial" returns available results; inspect the response’s partial flag.

zdr'enabled' | 'disabled'

enabled turns on zero data retention. Returns 403 ZDR_NOT_ENABLED unless your organization has ZDR.

tagsstring[]

Labels for filtering usage in the dashboard.

Comma-separated labels for filtering usage, e.g. production,team-alpha.

[
  "production",
  "team-alpha"
]

Response

Successful response

partialboolean

True when the timeout ended processing and this response contains only usable results completed so far. Unfinished results are omitted.

statusstring

Always ok on success.

domainstring

Domain found for the brand

typestring

Industry classification type, for naics api it will be naics

request_idstring uuid required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example response

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
}

Changes

  • 61627728926bRevision changes
    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

  • aeb64a2b7925Revision changes
    • warning

      added the new USAGE_EXCEEDED enum value to the response property for the response status