1. Supplier API
  • Supplier API
    • Guides
    • Retrieve Global Definitions
      GET
    • Question Library Lookup
      GET
    • Question Library Answer Lookup
      GET
    • Get Available Surveys (all live surveys)
      GET
    • Get Available Surveys By Id
      GET
    • Get Survey Transactions Data
      GET
    • Get Survey Stats
      GET
    • Get Recontacts
      GET
  1. Supplier API

Get Survey Transactions Data

Sandbox Env
https://supplier-stage.surveysherpa.com
Sandbox Env
https://supplier-stage.surveysherpa.com
GET
https://supplier-stage.surveysherpa.com
/api/v1/supply/getSurveyTransactions/{Survey ID}
This API allows suppliers to retrieve transactional data for each survey. The response includes details such as the PID (panelist ID), transaction status, IP address, survey start time, survey end time, and other related information.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://supplier-stage.surveysherpa.com/api/v1/supply/getSurveyTransactions/123 or 121' \
--header 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NzAzODMwMzY4NWU1OTFjYjkyMGE2MWMiLCJzdXBwbGllcl9pZCI6MjYsImlhdCI6MTcyODI4MzM5NX0.IuaRhVmCrXFIZkSHcgN3Zss8eGGhxd3Q7MkfrAHCYb0'

Responses

🟢200OK
application/json
Body

Example
{
    "apiStatus": "success",
    "msg": "Survey transactions retrieved successfully.",
    "result": [
        {
            "termReason": "",
            "ip": "178.233.33.124",
            "verifyToken": 0,
            "token": "OG6Ietfr8eiLjPsYBSaNEZwx",
            "CPI": 5,
            "PID": "a6sd46ds",
            "clkDateTime": "2024-10-17T07:34:16.471Z",
            "status": "Client Completes",
            "trackId": ""
        },
        {
            "termReason": "",
            "ip": "37.155.161.99",
            "verifyToken": 0,
            "token": "OG6cDceSsVb3YHlVjyCgc9Ji",
            "CPI": 5,
            "PID": "as6d2",
            "clkDateTime": "2024-10-17T11:05:22.177Z",
            "status": "Client Fails",
            "trackId": ""
        },
        {
            "termReason": "",
            "ip": "88.230.189.68",
            "verifyToken": 0,
            "token": "OG2mIQ3UAEy30mO8eWzt4lRC",
            "CPI": 5,
            "PID": "test1",
            "clkDateTime": "2024-10-18T04:14:55.834Z",
            "status": "Client Completes",
            "trackId": "test123"
        }
    ]
}
Modified at 2025-08-20 05:34:10
Previous
Get Available Surveys By Id
Next
Get Survey Stats
Built with