Activity Log via API

Owned by Claudio Baldi
Last updated: Dec 02, 2024
2 min read

Context:

Buyer API can use this API endpoints for query activities logs

API CALL example:

GET <SERVER_BASE_URL>/activities/v2/search?{PARAMS}

Request

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 repeated

  • user - User name or email

  • trigger - triggered by a user or system - user or system

  • origin - entry origin - ui , api or all

  • startDate - format YYYY-MM-DD

  • endDate - format YYYY-MM-DD

  • company - operator only

Response

Response Code

201

Response Body

{ "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

400 - Bad Request

Response Body