Skip to main content
Glama

List QR code analytics

lob_qr_codes_list
Read-onlyIdempotent

List QR code scan analytics for mail pieces. Filter by scan date, mail-piece ID, or campaign ID. Obtain total scan counts by passing include and limit.

Instructions

List QR-code scan / analytics events for QR codes embedded in your mail pieces. For 'how many scans?' counts, pass include: ['total_count'] with limit: 1. Filter by date_scanned (e.g. { gt: '<iso>' } for 'last N days'), resource_id (scans tied to a specific mail piece), or campaign_id (scans for a whole campaign).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoHow many results to return (default 10, max 100).
beforeNoCursor for the previous page.
afterNoCursor for the next page.
includeNoResponse add-ons. Pass ['total_count'] alongside any filters and limit:1 to answer 'how many?' questions in a single call — far cheaper than paginating to count. Not accepted on nested order endpoints (buckslip/card orders) or /webhooks.
date_createdNoISO8601 date filter object with gt/gte/lt/lte keys, e.g. { gt: '2026-04-23T00:00:00Z' } for 'last 7 days'. Combine with include:['total_count'] and limit:1 for date-bounded counts.
metadataNoFilter by metadata key/value pairs.
resource_idNoFilter to scans tied to a specific mail-piece ID.
campaign_idNo
date_scannedNoISO8601 date filter object with gt/gte/lt/lte keys, e.g. { gt: '2026-04-23T00:00:00Z' } for 'last 7 days'. Combine with include:['total_count'] and limit:1 for date-bounded counts.
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate safe read-only operation. Description adds valuable behavioral insights like the counting optimization using include:['total_count'] with limit:1, and filter syntax examples, which go beyond annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences plus a bolded tip. No redundant information. The most important detail (list) comes first, followed by a key use case, then filter guidance. Highly efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

While there is no output schema, the description covers input parameters and a common use case well. It could mention what fields are returned, but for a list tool the input focus is sufficient.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 89% schema coverage, the description enhances understanding by demonstrating filter usage (date_scanned, resource_id, campaign_id) and explaining the special behavior of include for total counts. It also provides concrete ISO example for date filters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states it lists QR-code scan/analytics events for mail pieces. Distinguishes itself from sibling list tools by focusing on QR codes, and provides a specific example for counting scans.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear usage context: listing analytics events and counting scans via include and limit. Does not explicitly exclude other scenarios, but the specific resource makes usage obvious.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/optimize-overseas/lob-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server