Like Jitsu? Give us a star on ⭐ GitHub!

πŸ“œ Server Configuration

πŸ‘©β€πŸ”¬ Extending Jitsu

Overview
Destination Extensions
API Specs

Jitsu Internals

Test Mapping with Dry-Run

To figure out what structure will be used to store your event without saving it to the destination, you may use a dry run endpoint and get the structure of the processed event.

If you want to configure the destination so that it could not be used in production, i.e. no data is stored there, you may use staged parameter set to true (see more information at destination configuration section). Such destinations support only dry run operation until you switch them from the staged mode.

post/api/v1/events/dry-run?destination_id=[id]

The event will be processed by Jitsu - all the enrichment and type resolution steps will be applied. The response will have information field names, values, and data types of the event.

X-Auth-Token
required
header
string

Token authorization. Read more at Admin endpoints

destination_id
required
Query String Parameter
string

Destination id

Request body is JSON of event you want to test using the dry run. Response will contain fields with mapped (or inferred) types (read more about mapping)

Examples:

Request example
Request example
[
  {
    "field": "type",
    "type": "text",
    "value": "test"
  },
  {
    "field": "value",
    "type": "bigint",
    "value": 1
  },
  {
    "field": "new_field",
    "type": "text",
    "value": "value"
  },
  {
    "field": "one_more",
    "type": "bigint",
    "value": 31
  },
  {
    "field": "eventn_ctx_event_id",
    "type": "text",
    "value": "5b8ef217-7d80-47a1-9787-9ca98180d695"
  },
  {
    "field": "_timestamp",
    "type": "timestamp",
    "value": "2021-01-25T16:24:28.987259Z"
  },
  {
    "field": "source_ip",
    "type": "text",
    "value": "86.62.100.116"
  }
]