Test mapping with Dry-Run

Available since 1.28.0

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
Dry run

https://instance.com/api/v1/events/dry-run?destination_id=<id>
The event will be processed by Eventnative - all the enrichment and type resolution steps will be applied. The response will have information field names, values, and data types of the event.
Request
Response
Request
Headers
X-Auth-Token
required
string
token authorization (api_key)
Response
200: OK
Response body contains instance names (from server.name configuration section)
[
{
"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"
}
]
400: Bad Request
Response body contains the error message if request failed.
{
"message": "error text with details"
}
401: Unauthorized
Response body contains the error message
{
"message": "< authorization error message >"
}

Request body is JSON of event you want to test using the dry run. For example:

{
"type": "test",
"value": 1,
"new_field": "value",
"one_more": 31
}

See the example of the response at the Response tab above. The actual response will depend on destination configurations (enrichment rules, mappings, and so on).