Report Endpoints¶

Every collection with a report has a path ending in /report, and most also have a super form that attaches related records, see Super Reports for what that adds.

The ones reached for most often:

Notes on particular reports¶

Six groups do not behave like the rest. Read the one that covers the path you picked.

On hold and inactive plant reports exclude mother plants¶

The pooled and mother-specific reports partition your plants rather than overlap, so there is no double-counting, but if you want every on hold plant, request both /v2/plants/onhold/report and /v2/plants/mother/onhold/report and combine them.

Transfer reports have no super form¶

They return one row per transfer, with no include support. If you need the packages or transporters on each transfer, use a transfer manifest report (below) or page through a supercollection such as /v2/transfers/outgoing/active/super.

Transfer manifest reports work differently from every other report¶

They load packages and transporters for each transfer automatically; there is no include to add and no way to switch it off, then cross-join the result, so you get one row per package per transporter rather than one row per transfer. That is why their columns are prefixed by the object they came from (transfer., package., transporter., plus delivery. and transporterDetails. on outgoing, and transporterDetails. only on hub). Because that loading is automatic, there is no super form to graduate to. A super variant of each briefly existed and has been removed: it returned the same columns while making the loading opt-in, so a request without an include came back empty. If you were calling one, drop /super from the path, the report in the table is a superset of what it did.

Two things follow that surprise people:

• rowLimit counts transfers, not rows. It is applied before the join, so &rowLimit=100 can return several hundred rows.
• They cost budget even though they are plain reports. Loading related data for every transfer means these reports run out of the Metrc request budget at roughly 5,000 transfers, well before the 50,000 row cap their documentation shows. Filter to a date range or add &rowLimit=5000.

Hub transfer reports cover the transfers you transport¶

These are the rows on Metrc's "Transfers Hub" page, where your license is neither the shipper nor the recipient, so they appear in no other transfer report. Two things make them unusual:

• There is no active/inactive split. Metrc serves the whole collection from one path with no state parameter, so there is a single /v2/transfers/hub/report rather than the active/inactive pair every other transfer collection has.
• The manifest form is the cheapest of the three: at one Metrc request per transfer instead of two or four. Metrc returns the delivery and the transporter already flattened onto the record and embeds the driver legs, so packages are the only thing left to fetch. Those flattened fields appear under transfer.; there is no delivery. or transporter. group. transporterDetails. shows the first driver leg only; when transfer.multiVehicle or transfer.isLayover is true, the remaining legs are in the JSON response but cannot be represented in a flat grid. Both flags are in the default columns so you can tell when that is happening.

Tag orders use current and history rather than active/inactive¶

Those are Metrc's own names for the two tabs on its tag orders page, and the paths mirror them. Note that history here is a state of the collection, unlike /v2/packages/history, which is one package's audit trail. Each tag order carries its line items in a details array, returned with the order itself rather than through an include.

Processing jobs are currently Oregon-only¶

Metrc exposes the Processing module in Oregon; licenses in other states will get an empty report rather than an error. Unlike the other new collections these do have includes (createdPackages, sourcePackages and history) so the super report is a real one, and rowMode applies. Note that a job record also carries a packages array inline: that is Metrc's own partial projection, with processingJobId zeroed out on every entry, so use include=sourcePackages when you need those packages joined.

Some super reports add nothing¶

The tag, tag order, strain and location super reports return the same columns as their plain form. Metrc exposes no related data for those objects, so there is nothing extra for a super report to attach; they exist so every path follows the same pattern.

Next Steps¶

• Narrow what a report returns with Shaping a Report.
• Attach related records with Super Reports.
• Check the caps before a large run in Limits and Troubleshooting.