...
Context:
Buyer API can use this API endpoints for query activities logs
API CALL example:
Code Block |
---|
GET <SERVER_BASE_URL>/buyersactivities/v2/activities/search?{PARAMS} |
Request
...
Code Block |
---|
GET $apihost/activities/v2/search?surveys=764831&surveys=764832&user=purespectrum&trigger=system&origin=api&startDate=2024-01-01&endDate=2024-03-25 |
($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header)
Params:
surveys
- Survey ID - can be repeateduser
- User name or emailtrigger
- triggered by a user or system -user
orsystem
origin
- entry origin -ui
,api
orall
startDate
- formatYYYY-MM-DD
endDate
- formatYYYY-MM-DD
company
- operator only
Response
...
Response Code
201
Response Body
Code Block | ||
---|---|---|
| ||
{ "total": 4, "activities": [ { "survey_id": 764831, "user_id": 3103, "user_email": "filipe@ns2.com", "username": "Filipe Test", "message": "activated Supplier Rates option", "type": "Survey Edit", "timestamp": 1711035869355, "isExpire": false, "eventHandler": "user", "userCmp": 3624, "isVisible": true, "operatorAccess": true, "buyerAdmin": true, "buyerFull": false, "addInfo": "undefined", "platform": "API_PLATFORM" }, { "survey_id": 764831, "user_id": 3103, "user_email": "filipe@ns2.com", "username": "Filipe Test", "message": "added layered quota GENDER:Female", "type": "Survey Edit", "timestamp": 1711035868635, "isExpire": false, "eventHandler": "user", "userCmp": 3624, "isVisible": true, "operatorAccess": true, "buyerAdmin": true, "buyerFull": false, "addInfo": "undefined", "platform": "API_PLATFORM" }, { "survey_id": 764831, "user_id": 3103, "user_email": "filipe@ns2.com", "username": "Filipe Test", "message": "added layered quota GENDER:Male", "type": "Survey Edit", "timestamp": 1711035868633, "isExpire": false, "eventHandler": "user", "userCmp": 3624, "isVisible": true, "operatorAccess": true, "buyerAdmin": true, "buyerFull": false, "addInfo": "undefined", "platform": "API_PLATFORM" }, { "survey_id": 764831, "user_id": 3103, "user_email": "filipe@ns2.com", "username": "Filipe Test", "message": "changed qualification from GENDER:Male,Female,Prefer not to say to GENDER:Male,Female", "type": "Survey Edit", "timestamp": 1711035868630, "isExpire": false, "eventHandler": "user", "userCmp": 3624, "isVisible": true, "operatorAccess": true, "buyerAdmin": true, "buyerFull": false, "addInfo": "undefined", "platform": "API_PLATFORM" } ] } |
Validation
...
Response Code
TO BE ADDED400 - Bad Request
Response Body
Code Block |
---|
{TO BE ADDED?surveys=aaa { "message": "[surveys] - Invalid surveys: aaa," } ?trigger=asd { "message": "[trigger] - Trigger options allowed: `user` or `system`" } ?origin=asd { "message": "[origin] - Origin options allowed: `api`, `ui`, `all`" } ?startDate=xxxx { "message": "[startDate] - Invalid date format. Should be YYYY-MM-DD." } ?endDate=xxxx { "message": "[endDate] - Invalid date format. Should be YYYY-MM-DD." } ?company=asdf { "message": "[company] - Invalid data asdf - company should be a number!" } |