Skip to content

Reporting Format

Validation results should be reported in a consistent structure so they can be mapped into files, dashboards, APIs, or internal review queues.

Core Fields

FieldDescription
validation_resultTop-level result: VALID, INVALID, or COULD NOT VALIDATE.
error_categoryGrouped reason for the result. Empty for VALID; populated for INVALID or COULD NOT VALIDATE.
error_codeSpecific machine-readable code for the result. Can be populated for VALID, INVALID, or COULD NOT VALIDATE.
source_idIdentifier from the source file, feed, or request.
validated_atTimestamp for when the validation result was produced.
notesOptional human-readable context for review or debugging.

Result Semantics

Internal ResultMeaning
VALIDValidation reached a conclusion and the promotion or promo code is valid.
INVALIDValidation reached a conclusion and the promotion did not work.
COULD NOT VALIDATEValidation could not reach a conclusion.

Downstream Mapping

Downstream exports may map these internal results to different labels or spreadsheet fields.

When mapping results downstream:

  • Preserve the original input structure when one is provided.
  • Keep VALID, INVALID, and COULD NOT VALIDATE as the canonical internal results.
  • VALID can include an error code, but should not include an error category.
  • Include error categories and error codes where they help with review, tuning, or debugging.