Search
API docs by Redocly

Analytics and Data (analytics)

Data on seller analytics.

Analytics and Data

Data on seller analytics.

Sales Funnel

To access the methods, use a token for the Analytics category

Methods for getting statistics for:

  1. Product cards per period
  2. Product cards per days
  3. Grouped product cards per days
Timezones are presented in IANA format, the current list can be viewed here

Product Cards Statistics per Period{{ /api/analytics/v3/sales-funnel/products }}

Описание метода

The method generates a report on products by comparing key metrics — for example, cart additions, orders, and product card views — for the current period with a similar past one.

The brandNames, subjectIds, tagIds, and nmIds parameters can be empty [], in which case the response will return all of the seller's product cards.

If you specify multiple parameters, the response will include cards that match all of these parameters simultaneously. If no cards match the request parameters, an empty response [] will be returned.

You can get a report for a maximum of the last 365 days.

In the previous period's data:

  • The data in pastPeriod covers the same duration as in selectedPeriod
  • If the pastPeriod start date is more than a year before the current date, it will be adjusted to: pastPeriod.start = current date - 365 days

Pagination can be used.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Requested period

object

Period for comparison

nmIds
Array of integers <uint64> [ 0 .. 1000 ] items [ items <uint64 > ]

WB articles to include in the report. Leave empty to get a report for all products

brandNames
Array of strings

List of brands for filtering

subjectIds
Array of integers <uint64> [ items <uint64 > ]

List of subject IDs for filtering

tagIds
Array of integers <uint64> [ items <uint64 > ]

List of label IDs for filtering

skipDeletedNm
boolean

Hide deleted product cards

object (OrderBy)

Параметры сортировки

limit
integer <uint32>
Default: 50

Number of product cards in the response

offset
integer <uint32>
Default: 0

How many results to skip. For example, with value 10, the response will start with the 11 element

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "brandNames": [
    ],
  • "subjectIds": [
    ],
  • "tagIds": [
    ],
  • "skipDeletedNm": false,
  • "orderBy": {
    },
  • "limit": 50,
  • "offset": 10
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Product Cards Statistics per Days{{ /api/analytics/v3/sales-funnel/products/history }}

Описание метода

The method returns statistics for product cards by day or by week. Data is available on cart additions, orders, product card views, and so on.

You can get data for a maximum of the last week.

To get reports for a period of up to a year, use the Seller Analytics CSV methods. These methods are available only with a subscription to Jam extended analytics.
Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Requested period

nmIds
required
Array of integers <uint64> [ 0 .. 1000 ] items [ items <uint64 > ]

Артикулы WB, по которым нужно составить отчёт. Оставьте пустым, чтобы получить отчёт обо всех товарах

skipDeletedNm
boolean

Hide deleted product cards

aggregationLevel
string (Level)
Default: "day"
Enum: "day" "week"

Aggregation Type. If not specified, the default is aggregation by days.
Available aggregation levels: day, week

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "nmIds": [
    ],
  • "skipDeletedNm": true,
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
[
  • {
    }
]

Grouped Product Cards Statistics per Days{{ /api/analytics/v3/sales-funnel/grouped/history }}

Описание метода

The method returns statistics for product cards by day or by week. Product cards are grouped by subjects, brands and tags. Data is available on cart additions, orders, product card views, and so on.

The brandNames, subjectIDs, tagIds, and nmIds parameters can be empty [], in which case the response will return all of the seller's product cards.

The product of the number of subjects, brands, and tags in the request cannot be more than 16. For example, 4 brands and 4 subjects or 2 subjects, 2 tags, and 4 brands.

You can get data for a maximum of the last week.

To get reports for a period of up to a year, use the Seller Analytics CSV methods. These methods are available only with a subscription to Jam extended analytics.
Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object

Requested period

brandNames
Array of strings

List of brands for filtering

subjectIds
Array of integers <uint64> [ items <uint64 > ]

List of subject IDs for filtering

tagIds
Array of integers <uint64> [ items <uint64 > ]

List of label IDs for filtering

skipDeletedNm
boolean

Hide deleted product cards

aggregationLevel
string (Level)
Default: "day"
Enum: "day" "week"

Aggregation Type. If not specified, the default is aggregation by days.
Available aggregation levels: day, week

Responses

Request samples

Content type
application/json
{
  • "selectedPeriod": {
    },
  • "brandNames": [
    ],
  • "subjectIds": [
    ],
  • "tagIds": [
    ],
  • "skipDeletedNm": false,
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Retrieving product card (PC) statistics for a selected period, based on nmID/items/brands/labels{{ /api/v2/nm-report/detail }} Deprecated

Описание метода

This method is deprecated. It will be removed on December 9

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
brandNames
Array of strings

Brands

objectIDs
Array of integers <int32> [ items <int32 > ]

Item Identifiers

tagIDs
Array of integers <int32> [ items <int32 > ]

Numeric label identifiers

nmIDs
Array of integers <int32> [ items <int32 > ]

WB articles

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

required
object

Period

object

Sorting parameters. If not specified, the default is "openCard" with descending order.
All sorting options field:

  • openCard — by card opening (transition to the product page)
  • addToCart — by additions to the cart
  • orders — by the number of orders
  • avgRubPrice — by average price in rubles
  • ordersSumRub — by the total order amount in rubles
  • stockMpQty — by the quantity of marketplace stock (pieces)
  • stockWbQty — by the quantity of warehouse stock (pieces)
  • cancelSumRub — by the sum of returns in rubles
  • cancelCount — by the number of returns
  • buyoutCount — by the number of buyouts
  • buyoutSumRub — by the total buyout amount in rubles
page
required
integer <int32>

Page

Responses

Request samples

Content type
application/json
{
  • "brandNames": [
    ],
  • "objectIDs": [
    ],
  • "tagIDs": [
    ],
  • "nmIDs": [
    ],
  • "timezone": "Europe/Moscow",
  • "period": {
    },
  • "orderBy": {
    },
  • "page": 1
}

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Product Cards Statistics by Days{{ /api/v2/nm-report/detail/history }} Deprecated

Описание метода

This method is deprecated. It will be removed on December 9

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
required
Array of integers <int32> [ items <int32 > ]

WB article (maximum 20)

required
object

Period

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

aggregationLevel
string

Aggregation Type. If not specified, the default is aggregation by days.
Available aggregation levels: day, week, month

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Product Cards Group Statistics by Days{{ /api/v2/nm-report/grouped/history }} Deprecated

Описание метода

This method is deprecated. It will be removed on December 9

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
objectIDs
Array of integers <int32> [ items <int32 > ]

Item Identifiers

brandNames
Array of strings

Brands

tagIDs
Array of integers <int32> [ items <int32 > ]

Numeric label identifiers

required
object

Period

timezone
string

Timezone.
If not specified, the default is Europe/Moscow

aggregationLevel
string

Aggregation Type. If not specified, the default is aggregation

Responses

Request samples

Content type
application/json
{
  • "objectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "period": {
    },
  • "timezone": "Europe/Moscow",
  • "aggregationLevel": "day"
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "error": true,
  • "errorText": "",
  • "additionalErrors": [
    ]
}

Search Queries

To access the methods, use a token for the Analytics category

These methods can be used to obtain a report on search queries.

You can use these methods only with Jam subscription

Main Page{{ /api/v2/search-report/report }}

Описание метода

Forms a dataset for the main report page with:

  • General information
  • Product positions
  • Data on visibility and transitions to the product card
  • Data for the table by groups

To obtain additional data in the table, use a separate request for:

  • Pagination by groups
  • Retrieval of products within a group

Additional parameters for selecting the list of products in the table:

  • positionCluster — average position in search

The parameters includeSubstitutedSKUs and includeSearchTexts cannot both be set to false

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

List of WB article numbers for filtering

subjectIds
Array of integers <int32> [ items <int32 > ]

List of subject IDs for filtering

brandNames
Array of strings

List of brands for filtering

tagIds
Array of integers <int64> [ items <int64 > ]

List of label IDs for filtering

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

Which average search position of products to display in the report:

  • all — all
  • firstHundred — from 1 to 100
  • secondHundred — from 101 to 200
  • below — from 201 and below
required
object (OrderBy)

Параметры сортировки

includeSubstitutedSKUs
boolean
Default: true

Show data for direct queries with promo items

includeSearchTexts
boolean
Default: true

Show data for search queries without promo items

limit
required
integer <uint32> <= 1000

Number of product groups in the response

offset
required
integer <uint32>

From which element to start outputting data

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "positionCluster": "all",
  • "orderBy": {
    },
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 130,
  • "offset": 50
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Pagination by Groups{{ /api/v2/search-report/table/groups }}

Описание метода

Pagination by groups in the report. It is possible only if there is a filter by brand, subject, or tag.

Additional parameters for selecting the list of products in the table:

  • positionCluster — average position in search

The parameters includeSubstitutedSKUs and includeSearchTexts cannot both be set to false

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

nmIds
Array of integers <int32> [ items <int32 > ]

List of WB article numbers for filtering

subjectIds
Array of integers <int32> [ items <int32 > ]

List of subject IDs for filtering

brandNames
Array of strings

List of brands for filtering

tagIds
Array of integers <int64> [ items <int64 > ]

List of label IDs for filtering

required
object (OrderByGrTe)

Sorting parameters

positionCluster
required
string (PositionCluster)
Enum: "all" "firstHundred" "secondHundred" "below"

Which average search position of products to display in the report:

  • all — all
  • firstHundred — from 1 to 100
  • secondHundred — from 101 to 200
  • below — from 201 and below
includeSubstitutedSKUs
boolean
Default: true

Show data for direct queries with promo items

includeSearchTexts
boolean
Default: true

Show data for search queries without promo items

limit
required
integer <uint32> <= 1000

Number of product groups in the response

offset
required
integer <uint32>

From which element to start outputting data

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "subjectIds": [
    ],
  • "brandNames": [
    ],
  • "tagIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 130,
  • "offset": 50
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Pagination by Products Within a Group{{ /api/v2/search-report/table/details }}

Описание метода

Pagination by products within a group. It is possible regardless of the presence of filters.

Filters for pagination by products within a group or without filters:

  • tuple subjectId, brandName, tagId — filter for the group
  • nmIds — filter by nomenclature

Additional parameters for selecting the list of products in the table:

  • positionCluster — average position in search

The parameters includeSubstitutedSKUs and includeSearchTexts cannot both be set to false

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

subjectId
integer <int32>

Subject ID

brandName
string

Product name

tagId
integer <int64>

Label ID

nmIds
Array of integers <uint64> <= 50 items [ items <uint64 > ]

WB article numbers list

required
object (OrderBy)

Параметры сортировки

positionCluster
required
string
Enum: "all" "firstHundred" "secondHundred" "below"

Which average search position of products to display in the report:

  • all — all
  • firstHundred — from 1 to 100
  • secondHundred — from 101 to 200
  • below — from 201 and below
includeSubstitutedSKUs
boolean
Default: true

Show data for direct queries with promo items

includeSearchTexts
boolean
Default: true

Show data for search queries without promo items

limit
required
integer <uint32> <= 1000

Number of products in the response

offset
required
integer <uint32>

From which element to start outputting data

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "subjectId": 123,
  • "brandName": "Apple",
  • "tagId": 45,
  • "nmIds": [
    ],
  • "orderBy": {
    },
  • "positionCluster": "all",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Search Texts by Product{{ /api/v2/search-report/product/search-texts }}

Описание метода

Forms the top search texts by product.

Search text selection parameters:

  • limit — number of queries, maximum 30 (for the Advanced tariff, the maximum is 100)
  • topOrderBy — method for selecting the top queries

The parameters includeSubstitutedSKUs and includeSearchTexts cannot both be set to false

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (Period)

Current period

object (pastPeriod)

Previous period for comparison. Number of days — less than or equal to currentPeriod

nmIds
required
Array of integers <uint64> <= 50 items [ items <uint64 > ]

WB article numbers list

topOrderBy
required
string
Enum: "openCard" "addToCart" "openToCart" "orders" "cartToOrder"

Filtering by the search queries that brought the most:

  • openCard — transitions to the product card
  • addToCart — adding items to the cart
  • openToCart — conversion to cart
  • orders — ordered products
  • cartToOrder — conversion to order
includeSubstitutedSKUs
boolean
Default: true

Show data for direct queries with promo items

includeSearchTexts
boolean
Default: true

Show data for search queries without promo items

required
object (OrderByGrTe)

Sorting parameters

required
StandardTariff (integer) or AdvancedTariff (integer) (TextLimit)

Responses

Request samples

Content type
application/json
{
  • "currentPeriod": {
    },
  • "pastPeriod": {
    },
  • "nmIds": [
    ],
  • "topOrderBy": "openToCart",
  • "includeSubstitutedSKUs": true,
  • "includeSearchTexts": false,
  • "orderBy": {
    },
  • "limit": 20
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Orders and Positions by Product Search Texts{{ /api/v2/search-report/product/orders }}

Описание метода

Forms data for a table on the number of orders and positions by queries. The data is specified within a period for a specific product

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
object (PeriodOrdersRequest)

Current period. Maximum of 7 days

nmId
required
integer <uint64>

WB article

searchTexts
required
Array of strings [ 1 .. 30 ] items

Search texts. For the Advanced tariff, the maximum is 100

Responses

Request samples

Content type
application/json
{
  • "period": {
    },
  • "nmId": 211131895,
  • "searchTexts": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Stocks Report

To access the methods, use a token for the Analytics category

These methods can be used to get a report on inventory history.

This is information from the detailed product table and the region and warehouse detail widget.

The stocks in this version of the methods are for the current day.

Group data{{ /api/v2/stocks-report/products/groups }}

Описание метода

Forms a dataset for inventory by product group.

The product group is described by a tuple of subjectID, brandName, tagID.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

List of WB article numbers for filtering

subjectIDs
Array of integers <int32> [ items <int32 > ]

List of subject IDs for filtering

brandNames
Array of strings

List of brands for filtering

tagIDs
Array of integers <int64> [ items <int64 > ]

List of label IDs for filtering

required
object (PeriodSt)

Period

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Type of products storage warehouse:

  • "" — all
  • wb — WB warehouses
  • mp — seller's warehouses (FBS)
skipDeletedNm
required
boolean

To skip deleted product cards

availabilityFilters
required
Array of strings (availabilityFilters)
Items Enum: "deficient" "actual" "balanced" "nonActual" "nonLiquid" "invalidData"

Доступность товара:

  • deficient — Low stock
  • actual — Selling well
  • balanced — Selling steadily
  • nonActual — Selling poorly
  • nonLiquid — Struggling
  • invalidData — Not calculated
required
object (TableOrderBy)

Sorting parameters

limit
integer <uint32> <= 1000
Default: 100

Number of groups in the response

offset
required
integer <uint32>

From which element to start outputting data

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "availabilityFilters": [
    ],
  • "orderBy": {
    },
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Product data{{ /api/v2/stocks-report/products/products }}

Описание метода

Forms a dataset for inventory by products.

You can get data for individual products as well as for the entire report if there are no filters in the query: nmIDs, subjectID, brandName, tagID.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

List of WB article numbers for filtering

subjectID
integer <int32>

Subject ID

brandName
string

Brand

tagID
integer <int64>

Tag ID

required
object (PeriodSt)

Period

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Type of products storage warehouse:

  • "" — all
  • wb — WB warehouses
  • mp — seller's warehouses (FBS)
skipDeletedNm
required
boolean

To skip deleted product cards

required
object (TableOrderBy)

Sorting parameters

availabilityFilters
required
Array of strings (availabilityFilters)
Items Enum: "deficient" "actual" "balanced" "nonActual" "nonLiquid" "invalidData"

Доступность товара:

  • deficient — Low stock
  • actual — Selling well
  • balanced — Selling steadily
  • nonActual — Selling poorly
  • nonLiquid — Struggling
  • invalidData — Not calculated
limit
integer <uint32> <= 1000
Default: 100

Number of groups in the response

offset
required
integer <uint32>

From which element to start outputting data

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectID": 123456,
  • "brandName": "Спортик",
  • "tagID": 25345,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": true,
  • "orderBy": {
    },
  • "availabilityFilters": [
    ],
  • "limit": 150,
  • "offset": 100
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Size data{{ /api/v2/stocks-report/products/sizes }}

Описание метода

Forms a dataset for inventory by the size of the product.

Possible cases:

  1. The product has dimensions and "includeOffice":true, then the response body will contain data on the inventory for each of the sizes with nested details by warehouse.
  2. The product has dimensions and "includeOffice":false, then the response body will contain data on the inventory for each of the sizes without nested details by warehouse.
  3. The product has no size and "include Office":true, then the response body will contain details by warehouse without data on the inventory for each of the sizes.
  4. The product has no size and "include Office":false, then the response body will be empty.

    The product has no size means the size of the product is the same and has "techSize":"0". In responses of the method for obtaining data on products, such products have hasSizes':false.

    The data on the seller's warehouses (FBS) are in an aggregated form — for all of them together without detailing specific warehouses — and responses contain "regionName":"Маркетплейс" and "officeName":"" in such cases.
Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmID
required
integer <int64>

WB article

required
object (PeriodSt)

Period

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Type of products storage warehouse:

  • "" — all
  • wb — WB warehouses
  • mp — seller's warehouses (FBS)
required
object (TableOrderBy)

Sorting parameters

includeOffice
required
boolean

Include warehouse details

Responses

Request samples

Content type
application/json
{
  • "nmID": 123456789,
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "orderBy": {
    },
  • "includeOffice": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Warehouse data{{ /api/v2/stocks-report/offices }}

Описание метода

Forms a dataset for inventory by warehouses.

The data on the seller's warehouses (FBS) are in an aggregated form — for all of them together without detailing specific warehouses — and responses contain "regionName":"Маркетплейс" and "offices":[].

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
nmIDs
Array of integers <int64> [ items <int64 > ]

List of WB article numbers for filtering

subjectIDs
Array of integers <int32> [ items <int32 > ]

List of subject IDs for filtering

brandNames
Array of strings

List of brands for filtering

tagIDs
Array of integers <int64> [ items <int64 > ]

List of label IDs for filtering

required
object (PeriodSt)

Period

stockType
required
string (StockType)
Enum: "" "wb" "mp"

Type of products storage warehouse:

  • "" — all
  • wb — WB warehouses
  • mp — seller's warehouses (FBS)
skipDeletedNm
required
boolean

To skip deleted product cards

Responses

Request samples

Content type
application/json
{
  • "nmIDs": [
    ],
  • "subjectIDs": [
    ],
  • "brandNames": [
    ],
  • "tagIDs": [
    ],
  • "currentPeriod": {
    },
  • "stockType": "mp",
  • "skipDeletedNm": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Seller Analytics CSV

To access the methods, use a token for the Analytics category

You can use these methods — except for stocks report — only with Jam subscription.

To get a report:

  1. Generate it using the method Create the report.
  2. Wait until the report is ready. You can check the status with the method Get the reports list. The report is stored for 48 hours after it is ready, and it cannot be retrieved after.
    If you receive a status of FAILED, regenerate the report.
  3. Download the report.

You can obtain a report for a maximum of one year.

The maximum number of reports that can be generated per day is 20

Create the report{{ /api/v2/nm-report/downloads }}

Описание метода

The method creates a task for generating a report with advanced seller analytics.

You can create a CSV-version of sales funnel or search parameters report with grouping:

  • by WB articles
  • by categories, brands, and labels

In each of reports on sales funnel, you can group data by days, weeks, or months.

Also you can create a CSV-version of search texts or stocks report.

The parameters includeSubstitutedSKUs and includeSearchTexts cannot both be set to false

If it was not possible to obtain report, you can create a repeat generation task. You can also get a list and check the statuses of reports.

Stocks report — the StocksReportReq model — can be created without Jam subscription
Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
id
required
string <uuid>

Report ID in UUID format. Generated by the seller independently

reportType
required
string

Report type — DETAIL_HISTORY_REPORT

userReportName
string

Report name. If not specified, it will be generated automatically

required
object

Report parameters

Responses

Request samples

Content type
application/json
Example

Sales funnel report. By WB articles

{
  • "id": "06eae887-9d9f-491f-b16a-bb1766fcb8d2",
  • "reportType": "DETAIL_HISTORY_REPORT",
  • "userReportName": "Card report",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "data": "Created"
}

Get the reports list{{ /api/v2/nm-report/downloads }}

Описание метода

The method provides a list of reports with advanced seller analytics. The response contains report IDs and generation statuses.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
query Parameters
filter[downloadIds]
Array of strings <uuid> [ items <uuid > ]

Report ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Regenerate the report{{ /api/v2/nm-report/downloads/retry }}

Описание метода

The method creates a repeated generation task of report with advanced seller analytics. This is necessary if you received the status FAILED when generating the report.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
downloadId
string <uuid>

Report ID

Responses

Request samples

Content type
application/json
{
  • "downloadId": "06eea887-9d9f-491f-b16a-bb1766fcb8d2"
}

Response samples

Content type
application/json
{
  • "data": "Retry"
}

Get the report{{ /api/v2/nm-report/downloads/file/{downloadId} }}

Описание метода

The method provides a report with advanced seller analytics by generation task ID.

You can get a report that was generated within the last 48 hours.
The report will be downloaded inside a ZIP archive in CSV format.

Request limit per one seller's account:
Period Limit Interval Burst
1 minute 3 requests 20 seconds 3 requests
Authorizations:
HeaderApiKey
path Parameters
downloadId
required
string <uuid>

Report ID

Responses

Response samples

Content type
application/zip
Example
nmID, dt, openCardCount, addToCartCount, ordersCount, ordersSumRub, buyoutsCount, buyoutsSumRub, cancelCount, cancelSumRub, addToCartConversion, cartToOrderConversion, buyoutPercent, addToWishlist
70027655,2024-11-21,1,0,0,0,0,0,0,0,0,0,0,0
...
...
150317666,2024-11-21,2,0,0,0,0,0,0,0,0,0,0,0