queryType: getIndustries

The getIndustries queryType is passed to the API to get a list of industry information.

Parameters

These parameters should be passed to the functionParameters object regardless of which method you choose from here.

ParameterDescriptionTypeDefined Value SetValue Required
queryTypeMust equal getIndustries.STRINGgetIndustriesY

level

INTEGER

Numeric hierarchy level (1=Sector, 2=Subsector, 3=Industry Group, 4=NAICS Industry, 5=National Industry).

isPurchasedForPOI

BOOLEAN

true if this category is licensed for POI Location Specific Insights use on this database. Only categories where this field is true can be used as the naicsLevel2 parameter in POI LSI calls.

Responses

CodeTypeDescription
200JSONThe requested data.
401JSONOccurs for various unauthorized tasks, such as not providing credentials in your parameters.
500JSONOccurs if an internal server error occurs. Contact Altitude Support if this occurs.

Response Schema

AttributeDescriptionData TypeDefined Value Set

code

INTEGER

NAICS category code value.

description

STRING

Standard description for this NAICS code.

levelName

STRING

The hierarchy level name of this code: Sector, Subsector, Industry Group, NAICS Industry, or National Industry.

Sample parameters


{
"queryType": "getIndustries"
}

// REST endpoint: GET /api/v2/filters/naics?minNAICSLevel=2&maxNAICSLevel=2
            

POI Location Specific Insights usage

Use getIndustries to discover which categories are available for POI Location Specific Insights before calling getPointsOfInterest, getPOISummary, or getPOIAnalytics. POI Location Specific Insights queries use Level 2 (Subsector) codes as the category parameter.

  • To narrow results to your licensed POI categories, filter the response to rows where isPurchasedForPOI = true.

  • The categories licensed for POI use on your database are also returned as a summary array by getDatabaseInfo (poiNaicsAllowed field).

  • To retrieve only Level 2 codes, pass minNAICSLevel=2 and maxNAICSLevel=2.