Engagement report

get

https://api.mrpeasy.com/rest/v2/items/reports/engagement/{article_id}

Get the engagement report for an item (BOMs where the item is used as a component). The report is keyed by the item variation ID ({article_id}), mirroring the web report.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

article_id

integer

required

Item variation (article) id.

Query Params

group_code

string | null

Filter by product group number (partial match).

group_title

string | null

Filter by product group name (partial match).

product_code

string | null

Filter by product number (partial match).

product_title

string | null

Filter by product name (partial match).

bom_code

string | null

Filter by BOM code (partial match).

bom_title

string | null

Filter by BOM name (partial match).

quantity_min

string | null

Minimum engaged quantity per BOM.

quantity_max

string | null

Maximum engaged quantity per BOM.

level_min

integer | null

Minimum BOM nesting level.

level_max

integer | null

Maximum BOM nesting level.

unit_id

integer | null

Filter by unit of measure id.

limit

integer

Maximum number of records to return (1–1000).

offset

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

404

Item not found

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of BOMs that use the item as a component

422Validation error