{"_id":"5cd4c3b1a95ded0058517d36","project":"59de6011debd1200240f68ec","version":{"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z","categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"5cd4c29c6ea1040056ec0f55","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-05-10T00:15:24.084Z","from_sync":false,"order":9999,"slug":"users","title":"Users"},"user":"59de7cde035e0d002eaefabe","__v":8,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-10T00:20:01.448Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n   \"activities\" : [\n      {\n         \"activity_type\" : \"doc_upload.file_uploaded\",\n         \"activity\" : {\n            \"field\" : null,\n            \"stage_title\" : \"Data Collection Stage\",\n            \"stage_id\" : 227206\n         },\n         \"owner_id\" : 6776,\n         \"id\" : 362789032,\n         \"owner_type\" : \"User\"\n      },\n      {\n         \"owner_type\" : \"User\",\n         \"id\" : 364360619,\n         \"owner_id\" : 6776,\n         \"activity\" : {},\n         \"activity_type\" : \"applicant.created\"\n      },\n      {\n         \"activity\" : {},\n         \"activity_type\" : \"applicant.created\",\n         \"owner_type\" : \"User\",\n         \"owner_id\" : 6776,\n         \"id\" : 371435397\n      },\n      {\n         \"id\" : 376261242,\n         \"owner_id\" : 6776,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"email.general\",\n         \"activity\" : {}\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 376270513,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"applicant.created\",\n         \"activity\" : {}\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 377217673,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"stage.transitioned\",\n         \"activity\" : {\n            \"funnel_id\" : 54942,\n            \"stage_title\" : \"Scheduler Stage\",\n            \"stage_id\" : 227203,\n            \"funnel_title\" : \"AAAAAAAAAA_Opening\"\n         }\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 377217674,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"slot.scheduled\",\n         \"activity\" : {}\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 378073550,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"applicant.created\",\n         \"activity\" : {}\n      },\n      {\n         \"activity_type\" : \"applicant.created\",\n         \"activity\" : {},\n         \"owner_id\" : 6776,\n         \"id\" : 378073598,\n         \"owner_type\" : \"User\"\n      },\n      {\n         \"owner_type\" : \"User\",\n         \"owner_id\" : 6776,\n         \"id\" : 378073623,\n         \"activity\" : {},\n         \"activity_type\" : \"applicant.created\"\n      }\n   ]\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X GET 'https://api.fountain.com/v2/user_activities/0b4ca8ca-de16-469b-8a7a-b03eb9566a56?start_time=2019-04-01&end_time=2019-04-28&per_page=10&page=1' -H 'X-ACCESS-TOKEN: aaabbbcccddd111222333444'"}]},"method":"get","auth":"required","params":[{"_id":"5cd4c4fbcd3dee00141c4d33","ref":"","in":"query","required":true,"desc":"API Token (not required if api_token is passed in header)","default":"secret-api-token","type":"string","name":"api_token"},{"_id":"5cd4c57bebe51c000f181c29","ref":"","in":"path","required":true,"desc":"ID of the user whose activity should be returned","default":"11111111-0000-0000-0000-000000000000","type":"string","name":"user_id"},{"_id":"5cd4c5c90cb1bf000f80bfd6","ref":"","in":"query","required":true,"desc":"","default":"","type":"yyyy-mm-dd","name":"start_time"},{"_id":"5cd4c5c90cb1bf000f80bfd5","ref":"","in":"query","required":true,"desc":"","default":"","type":"yyyy-mm-dd","name":"end_time"},{"_id":"5cd4c5c90cb1bf000f80bfd4","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"activity_type"},{"_id":"5cd4c5c90cb1bf000f80bfd3","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"per_page"},{"_id":"5cd4c5c90cb1bf000f80bfd2","ref":"","in":"query","required":false,"desc":"","default":"","type":"int","name":"page"}],"url":"/user_activities/:user_id"},"isReference":false,"order":999,"body":"# Overview\n\nThis endpoint allows you to query for all of the activity of a particular user. The endpoint allows filtering by date ranges and activity types.\n\nRetrieve user ID's using the `List all Users` endpoint.\n\n# Restrictions\n\nThe maximum date range is 1 month, otherwise an error will be returned.","excerpt":"","slug":"list-user-activities","type":"endpoint","title":"List User Activities"}

getList User Activities


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

user_id:
required
string11111111-0000-0000-0000-000000000000
ID of the user whose activity should be returned

Query Params

api_token:
required
stringsecret-api-token
API Token (not required if api_token is passed in header)
start_time:
required
yyyy-mm-dd
end_time:
required
yyyy-mm-dd
activity_type:
string
per_page:
integer
page:
integer

Examples


Result Format


Documentation

# Overview This endpoint allows you to query for all of the activity of a particular user. The endpoint allows filtering by date ranges and activity types. Retrieve user ID's using the `List all Users` endpoint. # Restrictions The maximum date range is 1 month, otherwise an error will be returned.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}