GET /api/public/pulse/

Get a list of pulse values.

Returns pulse values for all users within the company.

Response is paginated, with a default page size of 50 objects.

Servers

Query parameters

Name Type Required Description
page Integer No

Results page

updated_after String No

Only include users with updated date greater than or equal to the value.

created_on_start String No

Only include pulse values having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

created_before String No

Only include users with creation date less than or equal to the value.

created_on_end String No

Only include pulse values having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

created_after String No

Only include users with creation date greater than or equal to the value.

updated_before String No

Only include users with updated date less than or equal to the value.

report_id Integer No

Include only pulse values for a report/reports with the specified ID.

In order to query for pulse values for multiple reports, specify reports' ids as a list of parameters, eg.: ?report_id=1&report_id=2

user_id Integer No

Include only pulse values given by a user or users with the specified ID.

In order to query for pulse values given by multiple users, specify users' ids as a list of parameters, eg.: ?user_id=1&user_id=2

order_by String No

Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".

Possible values:

  • "create_ts"
  • "id"
  • "update_ts"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.