DAdatadive
v1

List all Niches

Changed on

Retrieves a paginated list of Niches. Each Niche represents a market segment or product category being tracked. Supports narrowing by name (searchText) or by a competitor ASIN (searchAsin), and ordering by last dive date or name. Walk the pages with currentPage until hasNext is false.

get/v1/niches

Request

  • Base URL
    https://api.datadive.tools
  • URL
    https://api.datadive.tools/v1/niches
  • Auth
    API key in header x-api-key

Query parameters

spacesnumber[]

Only items in at least one of these Spaces (ids from GET /v1/spaces). Repeat the parameter or use spaces[]=1&spaces[]=2. At most 100. Combines with labels and the other filters with AND.

[
  12,
  34
]
labelsnumber[]

Only items with at least one of these labels (ids from GET /v1/labels). Repeat the parameter or use labels[]=1&labels[]=2. At most 100. Combines with spaces and the other filters with AND.

[
  12,
  34
]
searchTextstring
Example:dog hat

Case-insensitive partial match on the Niche label or hero keyword

searchAsinstring
Example:B08N5WRWNW

Only Niches whose competitor set contains this ASIN

orderBy'lastDived' | 'name'

Sort field. lastDived orders by latestResearchDate, name by nicheLabel.

sortOrder'ASC' | 'DESC'

Sort direction. Defaults to DESC for lastDived and ASC for name.

currentPagenumber
Example:1

Page of items to retrieve (default 1)

pageSizenumber
Example:20

Items per page (default 20, max 50)

Response

currentPagenumber required
pageSizenumber required

Number of items per page

hasNextboolean required

True when there is a next page. Otherwise, false

hasPrevboolean required

True when there is a previous page. Otherwise, false

lastPagenumber required

Last page or total page count

totalnumber required

Total number of items

Example response

{
  "currentPage": 1,
  "pageSize": 20,
  "lastPage": 1,
  "total": 1,
  "data": [
    {
      "nicheId": "z515cGOFg3",
      "heroKeyword": "dog hat",
      "nicheLabel": "Dog-hat opportunity",
      "marketplace": "com",
      "spaces": [
        12,
        34
      ],
      "labels": [
        7
      ]
    }
  ]
}

Changes

  • 838b9910d190Revision changes
    • info

      added the new optional query request parameter labels

    • info

      added the new optional query request parameter spaces

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 0e41255f2949Revision changes
    • warning

      for the query request parameter pageSize, the max was set to 50.00

    • warning

      for the query request parameter currentPage, the min was set to 1.00

    • warning

      for the query request parameter pageSize, the min was set to 1.00

    • info

      added the new optional query request parameter orderBy

    • info

      added the new optional query request parameter searchAsin

    • info

      added the new optional query request parameter searchText

    • info

      added the new optional query request parameter sortOrder