Answered
Is it possible to access activity through API?
Best Reply
Sure, this can be done with the help of search queries in the List Topics endpoint. You can specify your search query in the "q" field of an API request. The channel name (ideas, questions, etc) is a part of the URL, no need to include it in the search query.
For example:
New ideas for March, 2018:
created:[2017-03-01T00:00:00Z TO 2017-03-31T00:00:00Z]
API URL with this example in our support account (don't mind the %'s, it is URL-encoded):
https://support.helprace.com/api/v1/spaces/1/ideas?q=created%3A%5B2017-03-01T00%3A00%3A00Z%20TO%202017-03-31T00%3A00%3A00Z%5D
Ideas planned in March, 2018:
status:planned created:[2017-03-01T00:00:00Z TO 2017-03-31T00:00:00Z]
etc.
If you only need the counts and minimize the payload size, you can select only one field to be returned in the fields parameter (e.g. "id") and all others will not be included.
https://support.helprace.com/api/v1/spaces/1/ideas?q=created%3A%5B2017-03-01T00%3A00%3A00Z%20TO%202017-03-31T00%3A00%3A00Z%5D&fields=id
The meta will still include the total count though.
"meta": { "count": 2, ...
5 replies
Could you please clarify what activity would you like to access via API? Recently added topics, all ticket events, something else?
Thanks!
Sure, all activities, as in:
https://url/s1-geral/ideas/activity/c0-all/
Edward
·
Thank you for clarifying. Although this sort of activity is not available via API calls, you can register a webhook that will call your script if there is any activity in your community:
You can find the list of webhook events here: Webhooks
Does this help? If not, please tell me more about what you're trying to achieve.
Not much.
Is it possible to have some report on the events? Such as # new ideais per month / week, # ideas planned, # ideais started, # ideas rejected, # ideas concluded?
Thanks.
Sure, this can be done with the help of search queries in the List Topics endpoint. You can specify your search query in the "q" field of an API request. The channel name (ideas, questions, etc) is a part of the URL, no need to include it in the search query.
For example:
New ideas for March, 2018:
created:[2017-03-01T00:00:00Z TO 2017-03-31T00:00:00Z]
API URL with this example in our support account (don't mind the %'s, it is URL-encoded):
https://support.helprace.com/api/v1/spaces/1/ideas?q=created%3A%5B2017-03-01T00%3A00%3A00Z%20TO%202017-03-31T00%3A00%3A00Z%5D
Ideas planned in March, 2018:
status:planned created:[2017-03-01T00:00:00Z TO 2017-03-31T00:00:00Z]
etc.
If you only need the counts and minimize the payload size, you can select only one field to be returned in the fields parameter (e.g. "id") and all others will not be included.
https://support.helprace.com/api/v1/spaces/1/ideas?q=created%3A%5B2017-03-01T00%3A00%3A00Z%20TO%202017-03-31T00%3A00%3A00Z%5D&fields=id
The meta will still include the total count though.
"meta": { "count": 2, ...
Cool, thanks!