{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/user_activities/:user_id","auth":"required","results":{"codes":[{"status":200,"language":"json","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         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"owner_type\" : \"User\",\n         \"id\" : 364360619,\n         \"owner_id\" : 6776,\n         \"activity\" : {},\n         \"activity_type\" : \"applicant.created\",\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"activity\" : {},\n         \"activity_type\" : \"applicant.created\",\n         \"owner_type\" : \"User\",\n         \"owner_id\" : 6776,\n         \"id\" : 371435397,\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"id\" : 376261242,\n         \"owner_id\" : 6776,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"email.general\",\n         \"activity\" : {},\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 376270513,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"applicant.created\",\n         \"activity\" : {},\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\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         \"applicant_id\": \"8624fd04-4b4d-4ddf-bb06-d8167d91690d\",\n         \"created_at\": \"2019-06-10T10:35:40.177-07:00\"\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 377217674,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"slot.scheduled\",\n         \"activity\" : {},\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"owner_id\" : 6776,\n         \"id\" : 378073550,\n         \"owner_type\" : \"User\",\n         \"activity_type\" : \"applicant.created\",\n         \"activity\" : {},\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"activity_type\" : \"applicant.created\",\n         \"activity\" : {},\n         \"owner_id\" : 6776,\n         \"id\" : 378073598,\n         \"owner_type\" : \"User\",\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"owner_type\" : \"User\",\n         \"owner_id\" : 6776,\n         \"id\" : 378073623,\n         \"activity\" : {},\n         \"activity_type\" : \"applicant.created\",\n         \"applicant_id\": null,\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\"\n      },\n      {\n         \"id\": 1205412412,\n         \"activity_type\": \"data_field.edit\",\n         \"activity\": {},\n         \"owner_type\": \"User\",\n         \"owner_id\": 49009,\n         \"applicant_id\": \"2e8079a8-cfbf-40cc-a6f0-ca39ed4f4ab9\",\n         \"created_at\": \"2019-06-04T15:49:18.048-07:00\",\n         \"key\": \"start_date\"\n      }\n   ]\n}","name":""}]},"settings":"","params":[{"name":"user_id","type":"string","default":"11111111-0000-0000-0000-000000000000","desc":"ID of the user whose activity should be returned","required":true,"in":"path","ref":"","_id":"5cd4c57bebe51c000f181c29"},{"name":"start_time","type":"yyyy-mm-dd","default":"","desc":"","required":true,"in":"query","ref":"","_id":"5cd4c5c90cb1bf000f80bfd6"},{"name":"end_time","type":"yyyy-mm-dd","default":"","desc":"","required":true,"in":"query","ref":"","_id":"5cd4c5c90cb1bf000f80bfd5"},{"name":"activity_type","type":"string","default":"","desc":"","required":false,"in":"query","ref":"","_id":"5cd4c5c90cb1bf000f80bfd4"},{"name":"per_page","type":"int","default":"","desc":"","required":false,"in":"query","ref":"","_id":"5cd4c5c90cb1bf000f80bfd3"},{"name":"page","type":"int","default":"","desc":"","required":false,"in":"query","ref":"","_id":"5cd4c5c90cb1bf000f80bfd2"},{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"API Access Token","required":true,"in":"header","ref":"","_id":"60d3a010193445004701a796"}],"examples":{"codes":[{"code":"curl -X GET -H 'X-ACCESS-TOKEN: aaabbbcccddd111222333444' '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'","language":"curl"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"List User Activities","type":"endpoint","slug":"list-user-activities","excerpt":"","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\nSome examples of logged user activities are creating Applicants, moving Applicants within an Opening, scheduling interviews, modifying Applicant profile data, and uploading a file to an Applicant's profile.\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.\n\n# Response Schema\nType: array\n  * id (integer)\n    * Unique identifier for each activity\n  * activity_type (string)\n    * Description of the user activity performed. Format is \"[Object].[Action]\". For example if an applicant is created, the `activity_type` = \"applicant.created\"\n    * activity (array)\n      * Some, but not all, user activities will come with contextual information about what Funnel or Stage the activity was performed\n  * owner_type (string)\n    * Description of the user type that performed this activity\n  * owner_id (integer)\n    * Unique identifier for the user that performed this activity\n  * applicant_id (string)\n    * Unique identifier for the Applicant affected by this ID.\n  * created_at (string)\n    * Timestamp for when this activity was performed\n  * key (string)\n    * Only relevant when `activity_type` = \"data_field.edit\". Identifies the Applicant data key that was modified.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cd4c3b1a95ded0058517d36","project":"59de6011debd1200240f68ec","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Users","slug":"users","order":11,"from_sync":false,"reference":false,"_id":"5cd4c29c6ea1040056ec0f55","project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2019-05-10T00:15:24.084Z","__v":0},"user":"59de7cde035e0d002eaefabe","createdAt":"2019-05-10T00:20:01.448Z","__v":17,"parentDoc":null}

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

start_time:
required
yyyy-mm-dd
end_time:
required
yyyy-mm-dd
activity_type:
string
per_page:
integer
page:
integer

Headers

X-ACCESS-TOKEN:
required
stringsecret-api-token
API Access Token

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. Some examples of logged user activities are creating Applicants, moving Applicants within an Opening, scheduling interviews, modifying Applicant profile data, and uploading a file to an Applicant's profile. Retrieve user ID's using the `List all Users` endpoint. # Restrictions The maximum date range is 1 month, otherwise an error will be returned. # Response Schema Type: array * id (integer) * Unique identifier for each activity * activity_type (string) * Description of the user activity performed. Format is "[Object].[Action]". For example if an applicant is created, the `activity_type` = "applicant.created" * activity (array) * Some, but not all, user activities will come with contextual information about what Funnel or Stage the activity was performed * owner_type (string) * Description of the user type that performed this activity * owner_id (integer) * Unique identifier for the user that performed this activity * applicant_id (string) * Unique identifier for the Applicant affected by this ID. * created_at (string) * Timestamp for when this activity was performed * key (string) * Only relevant when `activity_type` = "data_field.edit". Identifies the Applicant data key that was modified.

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 }}