Survey reconciliation

Description

Using this endpoint, you can reconcile transaction ids for both Closed or Live / Paused surveys.

Reconciliation of closed surveys

In order to reconcile in a closed survey, use this endpoint as is.

Reconciliation of live / paused surveys

In order to reconcile transactions in open surveys (live / paused), pass the operationType=LIVE_RECONCILIATION query parameter to the endpoint.

In order to accept or reject the transactions in the payload, you need to use the reconStatus query param, where:

1 means you accept the current transaction status

2 means you are changing the current transaction status into a new one

In live reconciliation, is possible to add for each transaction an additional field (change_reason) that allows you to add the reason for the the reconciliation.

If included, the reason value should be one of these options:

Suspected Fraud

Respondent Quality (speeding, straightlining, text response...)

Ghost Completes

Client Rejected

Duplicate Respondent

Any other variation is accepted and is recorded has Respondent Quality.

You can't reconcile test transaction IDs, only real completes can be reconciled.

Request

Path Params

Query Params

Header Params

Body Params application/json

Examples

Accept transaction ID statusReject transaction id status and provide reason

[
    {
        "transaction_id": "1NLTTi8htKM2h0wD3Erx7N"
    },
    {
        "transaction_id": "7dTdSUUWkR9DBs7rUi5jdT"
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": 1,
    "statusDescription": "Pending",
    "adjustment_id": "505c120f-3560-4c89-9706-811bf998abcd",
    "summary": {
        "currentCompletes": 0,
        "previouslyRejectedCompletes": 0,
        "rejectingCompletesInCurrentUpload": 0,
        "acceptingCompletesInCurrentUpload": 1,
        "resultingCompletes": 1,
        "totalRawCompletes": 1,
        "totalRejects": 0,
        "rejectPercentage": "0.00",
        "eligible": 1,
        "completes": 0,
        "rejected": 0,
        "test": 0,
        "alreadyReconciled": 0,
        "invalid": 0,
        "transactions": 1,
        "surveyStatus": [
            {
                "id": 1176671,
                "st": 44,
                "modelType": "surveys"
            }
        ],
        "summaryPerSurvey": [
            {
                "surveyId": 1176671,
                "currentCompletes": 0,
                "previouslyRejectedCompletes": 0,
                "rejectingCompletesInCurrentUpload": 0,
                "acceptingCompletesInCurrentUpload": 1,
                "resultingCompletes": 1,
                "totalRawCompletes": 1,
                "totalRejects": 0,
                "rejectPercentage": "0.00",
                "eligible": 1,
                "completes": 0,
                "rejected": 0,
                "test": 0,
                "alreadyReconciled": 0,
                "invalid": 0,
                "transactions": 1,
                "surveyStatus": [
                    {
                        "id": 1176671,
                        "st": 44,
                        "modelType": "surveys"
                    }
                ],
                "validCap": true
            }
        ],
        "validCap": true,
        "invoiced": 0,
        "isApiUser": true
    }
}

🟠400Bad Request

Description#

Reconciliation of closed surveys#

Reconciliation of live / paused surveys#

Request

Request Code Samples

Responses

Description

Reconciliation of closed surveys

Reconciliation of live / paused surveys