Remote system responses

Follow

 

What is a Remote System response?

A remote system response is what Leadbyte uses to mark an API delivery as successful or otherwise.

This response is returned by the receiving remote system.

Examples - 

HTTP status 200.

{"code":1,"response":"OK","info":[],"leadId":12345,"processTime":0.18,"timestamp":"2021-11-02T14:22:47Z","payout":"Complete"}

 

This section can be found in Campaign delivery settings:

LeadByte_-_Edit_-_Google_Chrome_2021-11-02_at_12.13.24_PM.jpeg

 

 

How to map your remote system responses.

This is bespoke for each system so refer to the integration guide or contact your buyer for more information.

 

 

Match By: Keyword

In the below example, every delivery response returned which contains the word 'Valid' would be marked as 'Success'

c5b3ada1-2ea2-445b-b7bc-cb1c3628b73f.png

Example responses:

{"code": 0, "response": "valid"}

{"code":1, "response": "invalid"}

Both of the above examples would be marked as success as they contain the word "valid"

 

 

Match By: Exact Match

Here, the system would be looking for an exact match on only the word 'Valid' without anything else.

f7f06016-47a7-44ef-bccb-ec8feff553fe.png

Example responses:

{"code": 0, "response": "valid"}

{"code":1, "response": "invalid"}

Both of the above responses will be marked as unsuccessful as they contain more than just the value "valid".

 

We would need to use the asterisk symbol to exclude the parts of the response we can ignore

download.png

Using the above screenshot, the below examples would be marked as successful:

{"code": 0, "response": "valid"}

{"status": "accepted", "id": "12345", "marked_as": "valid"}

 

 

Match By: HTTP Status

416a670b-18fb-4bda-b5b4-03ba901d60b8.png

In this case, the system would be looking for a specific HTTP code in the response.

Warning - a HTTP Status of 200 does NOT necessarily mean the lead has been marked as successful. ALWAYS check with your buyer/integration guide before setting this as your success response.

 

 

Marking successful responses

Only system responses  with the 'Success' checkbox marked will be counted as such.

Anything else will be deemed a failure

download__1_.png

In the above example, the green checkbox will be marked as a successful delivery, whereas the red checkbox will not

 

As always, please raise a support ticket with any questions.

Was this article helpful?
1 out of 1 found this helpful

Comments