| lens | No | Trend breakdown dimension (default "overview" — total volume only, no `sub_lens` needed). "product"/"issue"/"company" require `sub_lens` to be set, or upstream returns a 422 listing the valid sub-lens choices for that lens. | |
| state | No | Two-letter US state or territory postal abbreviation (e.g. "CA", "NY", "PR"). | |
| company | No | Exact registered company name as CFPB records it, typically uppercase with legal suffix (e.g. "EQUIFAX, INC.", "WELLS FARGO & COMPANY", "BANK OF AMERICA, NATIONAL ASSOCIATION"). A near-miss silently returns 0 results rather than an error. | |
| product | No | Exact CFPB product category — must match verbatim, e.g. "Credit reporting or other personal consumer reports", "Debt collection", "Mortgage", "Checking or savings account", "Credit card", "Credit card or prepaid card", "Money transfer, virtual currency, or money service", "Student loan", "Vehicle loan or lease", "Payday loan, title loan, personal loan, or advance loan", "Prepaid card". A near-miss (e.g. wrong wording) silently returns 0 results rather than an error. | |
| date_max | No | End of the date range, format YYYY-MM-DD. | |
| date_min | No | Start of the date range, format YYYY-MM-DD. | |
| sub_lens | No | Secondary breakdown required when `lens` is not "overview". Valid per lens: product→(sub_product, issue, company, tags); issue→(product, sub_issue, company, tags); company→(product, issue, tags). | |
| trend_interval | No | Time bucket size for the trend series (default "month"). | |