Get Survey Transactions data

This API allows supplier to download transactional data for each survey with fields like PID (supplier user Id), survey transaction status, IP Address, survey start time, survey end time etc.

Request

Path Params

Survey ID

string

required

Survey Id of particular survey (like : 6299)

Query Params

endDate

string

optional

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

startDate

string

optional

Start Date is beginning date (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.

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 {17}]

required

string

optional

verifyToken

string

optional

termReason

string

optional

CPI

string

optional

PID

string

optional

token

string

optional

st_date_time

string

optional

clkDateTime

string

optional

completeDateTime

string

optional

status

string

optional

trackId

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": [
        {
            "ip": "104.189.11.109",
            "verifyToken": "Pending",
            "termReason": "",
            "CPI": "0.26",
            "PID": "9834540538942",
            "token": "TrJHBnKhpW",
            "st_date_time": "10/24/2017, 2:12:24 am PST",
            "clkDateTime": "10/24/2017, 2:12:03 am PST",
            "completeDateTime": "10/24/2017, 2:12:33 am PST",
            "status": "Completed",
            "trackId": "6d30aa69-2693-4bce-91ab-1a85b69a72d5"
        }
    ]
}