Preview sample records
preview_recordsReturns up to 25 masked sample rows (10 by default) for an audience or a count id, each with verification badges, why it matches and a provenance card. Use it after count_audience to show the user what the records look like before quoting. Free: emails and phones are masked on the server, a repeat returns the same rows, and no rows come back when the count is under 25. Call quote_order next to price the records. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows to return, 1 to 25. Default 10. | |
| shuffle | No | Draw a new seed. Counts against your rate budget and is logged. Default false, so a repeat returns the same rows. | |
| audience | No | ||
| count_id | No | A count id instead of an audience. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Format: a preview id: prv_ followed by a 26 character ULID in upper case Crockford base32, such as prv_01JB4H3M7Q2V7XN3M9R6T1Y5W8. | |
| rows | Yes | ||
| seed | Yes | The seed the rows came from; the same audience gives the same seed. | |
| count | Yes | The count the rows were drawn from, rounded as disclosure says. | |
| masked | Yes | ||
| count_id | Yes | Format: a count id: cnt_ followed by 20 base32 characters (A to Z and 2 to 7), such as cnt_7K2PQ4MAXN3R6TBY5WDZ. | |
| withheld | Yes | Rows held back: all of them when the count is under 25, or rows whose title fewer than 10 people hold. | |
| watermark | Yes | The account id watermarked into sample CSVs; null when signed out. | |
| created_at | Yes | ||
| disclosure | Yes | ||
| dataset_version | Yes | The immutable weekly build a count is bound to, such as 2026-W39. The last 52 stay queryable. |