Skip to content

RescueTime

The RescueTime modules allow you to watch, start, end, daily summary reports, alerts, FocusTime sessions, and generate an analytic report in your RescueTime account.

Getting Started with RescueTime

Prerequisites

  • A RescueTime account

In order to use RescueTime with Ibexa Connect, it is necessary to have a RescueTime account. If you do not have one, you can create a RescueTime account at rescuetime.com/signup/solo/pro.

Connecting RescueTime to Ibexa Connect

To connect your RescueTime account to Ibexa Connect you need to obtain the API Key from your RescueTime account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Go to Ibexa Connect and open the RescueTime module's Create a connection dialog.

61f278880554b.gif

2. In the Connection name field, enter a name for the connection and click Continue.

3. Enter your RescueTime credentials and click Login.

61f2788a5d448.png

4. Confirm the access by clicking Authorize.

61f2788b913f8.png

The connection has been established.

Daily Summary

Watch Daily Summary Reports

Triggers by the new daily summary report.

Required Permissions: time_data

Limit Set the maximum number of daily summary reports Ibexa Connect should return during one scenario execution cycle.

Alert

Watch Alerts

Triggers by user-defined alerts. Only for RescueTime Premium users.

Required Permissions: alert_data

Triggers only for a specific alert

(Optional) Select the option if you want to receive alerts only for specific alerts:

  • More than 4 hours per day in All Productive time

  • More than 2 hours per day in All Distracting time

  • More than 1 minute per day in All Distracting time

Limit

Set the maximum number of alerts Ibexa Connect should return during one scenario execution cycle.

FocusTime Session

Watch FocusTime Sessions

Triggers by started or ended FocusTime Sessions. Only for RescueTime Premium users.

Required Permissions: focustime_data

Feed Type

Select the session type:

  • FocusTime Session Started

  • FocusTime Session Ended

Limit

Set the maximum number of alerts Ibexa Connect should return during one scenario execution cycle.

Start a FocusTime Session.

Starts a FocusTime session. Only for RescueTime premium users.

Required Permissions: focustime_data

How long do you want to focus?

Select the option to choose the session time:

  • Input a duration

  • Focus until the end of the day

Duration in Minutes

Enter the duration of the session in minutes. The duration must be a multiple of 5, or else it will be rounded off to the nearest 5 minutes. Must be higher than or equal to 5.

End a FocusTime Session

Ends a FocusTime session. Only for RescueTime premium users.

Required Permissions: focustime_data

Offline Time Record

Create an Offline Time Record

Creates an offline time record.

Required Permissions: focustime_data

Start Time Enter the start date/time for the offline time record in the YYYY-MM-DD HH:MM:SS format. A UNIX timestamp is also acceptable.
End Time Enter the end date/time for the offline time record in the YYYY-MM-DD HH:MM:SS format. A UNIX timestamp is also acceptable.
Activity Name Enter the name of the activity. For example, Meeting, Driving. A maximum of 255 characters is allowed.
Activity Details Enter the details of the activity. A maximum of 255 characters is allowed.

Highlight Event

Watch Highlight Events

Triggers by new highlighted events. Only for RescueTime premium users.

Required Permissions: highlight_data

Limit Set the maximum number of events Ibexa Connect should return during one scenario execution cycle.

Create a Highlight Event

Creates a highlight event. Only for RescueTime premium users.

Required Permissions: highlight_data

Highlight Date Enter the date of the event.
Description Enter the details of the event.
Source Label Enter an appropriate label for the event.

Other

Generate an Analytic Report

Generates an analytic report with various scopes of data.

Required Permissions: time_data

Perspective

Select the X-axis value for generating the analytic report:

  • Interval

  • Rank

Unit of Interval

Select the measuring unit of the value:

  • Day

  • Hour

  • Month

  • Minute

  • Week

Group By

Select the option to group the data:

  • Activity

  • Category

  • Document

  • Efficiency

  • Overview

  • Productivity

Source Type

Select the source type for the data:

  • Computer

  • Mobile

  • Offline

Begin Date

Enter the start date for the data from which you want to generate the report.

End Date

Enter the start date for the data until which you want to generate the report.

Name of Overview, Category, Application, or Website

Enter the name of the specific overview, category, application, or website. If it is a website, enter only the domain name. For example, www.nytimes.com, enter nytimes.com.It helps to retrieve a list that contains the name you want and inspect it for the exact names.

Name of the Document or Activity

Enter the name of the document or activity to record for the currently active application.

Schedule or Time Filter ID

Enter the Schedule ID or Time ID to filter the results.

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://www.rescuetime.com/api/oauth. For example: /data

For the list of available endpoints, refer to the RescueTime API Documentation.

Method

Select the HTTP method you want to use:

GET to retrieve information for an entry.

POST to create a new entry.

PUT to update/replace an existing entry.

PATCH to make a partial entry update.

DELETE to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Data

The following API call returns all the data from your RescueTime account:

URL:/data

Method:GET

Query String:Key: format Value: json

61f2788cb365c.png

Matches of the search can be found in the module's Output under Bundle > Body. In our example, the data details were returned:

61f2788dbddbd.png