Skip to main content

Search Lifestyles

GET 
/v4/lifestyles

This endpoint returns returns lifestyle trend information from Spatial AI. This data is based on where behaviors occur, not where people live. There are 72 lifestyle behaviors that are measured.



Currently the only countries supported are the United States of America and Canada.

Request​

Query Parameters

    boundary-id string[]required

    The boundary ID(s) to get lifestyle behavioral information on. Behavioral information will only be returned if the boundary exists and there is lifestyle information available for it. Only 20 boundary IDs can be supplied per request.

    Example: &boundary-id=593979d6da3374b282bb7bbb&boundary-id=593979d6da3374b282bb7bcb (maximum of 20 boundary-ids per request)
    exclude-slug string[]

    An array of slugs that represent a corresponding lifestyle behavior that you want excluded from the results.

    Example: &exclude-slug=partyLife&exclude-slug=dailyGrind
    limit number[]

    The number of lifestyle behaviors you want returned. There are 72 lifestyle behaviors that are measured. This is useful in cases where you only need the top lifestyle behaviors for a requested area.

    Example: &limit=10
    offset number

    Used for pagination, the number of records for the collection to skip.

    Default value: 0

    Example: &offset=10
    sort-by string

    Sort by any of the following parameters.

    • lifestyle
    • percentileVsNation

    Possible values: [lifestyle, percentileVsNation]

    Default value: percentileVsNation

    Example: &sort-by=percentileVsNation
    sort-order string

    The direction in which to sort using the following parameters.

    • asc (ascending order)
    • desc (descending order)

    Possible values: [asc, desc]

    Default value: desc

    Example: &sort-order=asc
    group-by string

    Group results by boundary ID instead of aggregating results for all included boundaries.

    • boundary-id

    Possible values: [boundary-id]

    Example: &group-by=boundary-id

Responses​

Schema

    successbooleanrequired

    data

    object[]

  • Array [

    • boundaryIdstring[]required

    The boundary id or ids used to aggregate lifestyle behavioral data.

    data

    object[]

    required

    Array of lifestyle behaviors. There are 72 lifestyle behaviors that are measured.

  • Array [

    • spatialAiIdstringrequired

    The id given for this lifestyle by Spatial AI.

    lifestylestringrequired

    The lifestyle behavior being measured. Measurements are based on where behaviors occurs, not where people live.

    slugstringrequired

    An easier to read id to be used when excluding lifestyle behaviors from the results.

    categorystringrequired

    The category the lifestyle behavior belongs to.

    percentileVsNationstringrequired

    A score representing percentile vs. the nation. A "Bookish" score of 80 means this area scored higher than 80% of the nation.

    imagestringrequired

    A visual representation of the lifestyle behavior.

    descriptionstringrequired

    A description of the lifestyle behavior being measured.

  • ]

  • ]