Sample data

Generate type-safe example records for testing a data model and its ingest path.

Last verified 2026-08-02

ReportPlane can generate a sample record from a data model. Samples are useful for checking field shape, testing an ingest client, and previewing an initial analytics definition.

How values are chosen

The generator follows the declared field type before using hints from the field name. This prevents misleading examples such as a text status value for an integer status_code field.

Examples:

  • status_code: integer receives a numeric HTTP-style status;
  • status: string can receive a semantic text value;
  • numeric *_id fields remain numeric;
  • integer time values use Unix milliseconds where that representation is required by the sample path;
  • arrays and objects preserve their declared structure.

Generate a sample

Open a data model and choose the sample-data action. Review the generated payload before sending it. A sample demonstrates a valid shape but should not be treated as production business data.

Sample generation is currently a console action and is not part of Management API v1.

Good testing practice

  1. Generate a sample.
  2. Replace placeholder identifiers with clearly marked test values.
  3. Send it through a non-production ingest client.
  4. Confirm acceptance and destination delivery.
  5. Run a small Analytics API over the stored record.
Was this page helpful?Send feedback