Debugging and testing¶
Many endpoints support additional query parameters that can help affect how the event is interpreted by the back end.
oa_debug¶
The oa_debug parameter can be set to true when you want to view a debug
console or response for the request. This will usually detail the request
parameters, the logs for the request handler, and the response or outcome of
the request.
This is the most helpful when working with the Click Tracking endpoint, since the debug screen will show you everything without redirecting.
Note
The Debug Console is currently only available for Click Tracking.
Example¶
Let's say we're tracking a click on a link we've added in an email. In order to check out the debug page, we take the following link:
https://r.orb.ee?oa_aid=1&oa_cpid=1&ap_ctid=1&oa_dest=https%3A%2F%2Fmy-website.com%2F
and we add &oa_debug=true to the end:
https://r.orb.ee?oa_aid=1&oa_cpid=1&ap_ctid=1&oa_dest=https%3A%2F%2Fmy-website.com%2F&oa_debug=true
Now we can send a sample email to ourself, and click the link. You'll see the following debug page:
oa_track¶
The oa_track parameter can be set to false when you want the event to be
blocked or ignored for all reporting in the Platform. Any request marked
with oa_debug=true will automatically have oa_track=false applied to them
as well.
You can view all debug and non-tracked events in the "For Developers" section of the Platform for more details.
Example¶
Let's say we're tracking a click on a link we've added in an email. In order to disable tracking (say to audit emails), we want to alter the following link:
https://r.orb.ee?oa_aid=1&oa_cpid=1&ap_ctid=1&oa_dest=https%3A%2F%2Fmy-website.com%2F
and add &oa_track=false to the end:
https://r.orb.ee?oa_aid=1&oa_cpid=1&ap_ctid=1&oa_dest=https%3A%2F%2Fmy-website.com%2F&oa_track=false
Now we can still click the link for testing, without tracking the click as a proper click from a shopper.