Get Survey Transactions data By Date Range

This API allows suppliers to get survey transaction records associated within the specified Date Range whether startDate and endDate/ verifiedStartDate and verifiedEndDate (in case of valid and invalid token).

Request

Query Params

endDate

string

required

End Date is ending date (like :2017-02-10)

startDate

string

required

Start Date is beginning date (like : 2017-01-02)

Verified End Date

string

optional

Verified End Date is ending date to get token which are verified upto that date (like : 2017-02-10)

Verified Start Date

string

optional

Verified Start Date is beginning date to get token which are verified(like : 2017-01-02)

status

string

optional

If we passed status along with Start Date and End Date then transaction status/ statuses (Pre Survey DNC/Completed/Failed/ Over Quota,Quality Termination/Pre Survey Termination/Start Survey DNC/Pre Survey Over Quota/Pre Survey Quality Termination) should be passed. ||||2. If we passed status along with Verified Start Date and Verified End Date then verified token status/statues (Valid/Invalid) should be passed

Header Params

x-access-token

string

required

YOUR_X-ACCESS-TOKEN_HERE

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

apiStatus

string

required

msg

string

required

result

array [object {20}]

required

string

required

string

required

verifyToken

string

required

termReason

string

required

grp

object

required

CPI

string

required

PID

string

required

st_date_time

string

required

clkDateTime

string

required

completeDateTime

string

required

surveyId

integer

required

status

string

required

trackId

string

required

verifiedTknDt

string

optional

QuestionId

integer

required

QuestionText

string

required

QuestionKey

string

required

QuestionType

string

required

language

string

required

Category

array[string]

required

Example

{
    "apiStatus": "success",
    "msg": "Survey Transactions are successfully searched",
    "result": [
        {
            "id": "THyBTPgJkf",
            "ip": "122.160.153.166",
            "verifyToken": "Pending",
            "termReason": "",
            "grp": {},
            "CPI": "1.57",
            "PID": "J1",
            "st_date_time": "11/07/2017, 1:08:15 am PST",
            "clkDateTime": "11/07/2017, 1:06:53 am PST",
            "completeDateTime": "11/07/2017, 1:09:33 am PST",
            "surveyId": 14344,
            "status": "Completed",
            "trackId": "6d30aa69-2693-4bce-91ab-1a85b69a72d5"
        },
        {
            "id": "THy8jOzDCW",
            "ip": "122.160.153.166",
            "verifyToken": "Valid",
            "termReason": "",
            "grp": {},
            "verifiedTknDt": "11/01/2017, 5:00:20 am PST",
            "CPI": "0.26",
            "PID": "test52",
            "st_date_time": "11/01/2017, 2:11:53 am PST",
            "clkDateTime": "11/01/2017, 2:11:35 am PST",
            "completeDateTime": "11/01/2017, 2:12:01 am PST",
            "surveyId": 14016,
            "status": "Completed",
            "trackId": ""
        }
    ]
}