API Reference
Activity
/activity
Get a list of recorded innovation Activity
Params
program | String | optional | The program ID |
userId | String | optional | A user ID |
userEmail | String | optional | A user's email |
action | String | optional | See queryable actions below |
If userId
and userEmail
are both included in the query, userId
will be used.
Example Request:
axios.get(`https://acmecorp.launchpath.io/api/v1-beta/activity`, {
headers: {
Authentication: `Bearer ${process.env.LAUNCHPATH_API_TOKEN}`,
Accept: 'application/json',
},
params: {
action: 'Idea Published',
},
})
Example Response:
{
"items": [
{
"timestamp": "2021-04-28T21:04:58.731+00:00",
"action": "Idea Published",
"actor": {
"_id": "5b36534a053fa30c90208ba6",
"email": "david.castillo@acmecorp.biz",
"name": "David Castillo"
},
"program": "632b771832d29d840043f72a",
"idea": {
"_id": "632b8431a7978d0f829ffcb7",
"name": "IT Revolution"
}
},
{
"timestamp": "2021-04-28T21:05:12.731+00:00",
"action": "Idea Published",
"actor": {
"_id": "5c1bd6c57bc30c64bd797d86",
"email": "william.schmidt@acmecorp.biz",
"name": "Bill Schmidt"
},
"program": "632b771832d29d840043f72a",
"idea": {
"_id": "590b8abc654e3610c3e4bdfc",
"name": "AI for Infrastructure"
}
}
]
}
Queryable Actions
Comment Posted
Decision Processed
- When a decision is made about a submitted Idea or ProjectFeedback Requested
- When a user requests peer feedbackIdea Archived
- When an idea is no longer being worked on. This could be because the Idea was advanced to a ProjectIdea Published
Idea Submitted
- When a user requests formal review of an IdeaLesson Completed
- When a user marks a lesson as complete in the Training areaProject Advanced
- When a project is moved to a new stageProject Initiated
- When a user advances an Idea to a ProjectProject Submitted
- When a user requests formal review of a ProjectReply Posted
User Activated
- When a user first logs in