Get Free/Busy Schedule with Microsoft Outlook Calendar API on New Report Generated from H-supertools Analytics Tool API

Pipedream makes it easy to connect APIs for Microsoft Outlook Calendar, H-supertools Analytics Tool and 3,000+ other apps remarkably fast.

Trigger workflow on

New Report Generated from the H-supertools Analytics Tool API

Next, do this

Get Free/Busy Schedule with the Microsoft Outlook Calendar API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a H-supertools Analytics Tool trigger and Microsoft Outlook Calendar action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Report Generated trigger
1. Connect your H-supertools Analytics Tool account
2. Configure timer
3. Select a Report Id
4. Select a Name
Configure the Get Free/Busy Schedule action
1. Connect your Microsoft Outlook Calendar account
2. Configure Schedules
3. Configure Start
4. Configure End
5. Select a Time Zone
6. Optional- Configure Availability View Interval
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Report Generated on H-supertools Analytics Tool

Description:Emit new event when a new analytics report is created.

Version:0.0.1

Key:h_supertools_analytics_tool-report-generated

View on GitHub

H-supertools Analytics Tool Overview#

The H-supertools Analytics Tool API provides insights about SEO and online marketing. With Pipedream, you can leverage these insights in automated workflows. Imagine triggering actions based on keyword volumes, tracking your website's position for certain keywords, or getting alerts when your SEO performance changes. Pipedream's serverless platform lets you connect the H-supertools Analytics Tool with various other apps and services, enabling a host of data-driven applications.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import app from "../../h_supertools_analytics_tool.app.mjs";

export default {
  name: "New Report Generated",
  version: "0.0.1",
  key: "h_supertools_analytics_tool-report-generated",
  description: "Emit new event when a new analytics report is created.",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    reportId: {
      propDefinition: [
        app,
        "reportId",
      ],
    },
    name: {
      propDefinition: [
        app,
        "name",
      ],
    },
  },
  methods: {
    emitEvent(data) {
      this.$emit(data, {
        id: data.value + data.count,
        summary: "New analytics report created!",
        ts: new Date,
      });
    },
  },
  async run() {
    const {
      app,
      reportId,
      name,
    } = this;

    const items = app.paginate({
      fn: app.retrieveReportData,
      reportId,
      params: {
        name,
        from: "1970-01-01",
        to: moment().format("YYYY-MM-DD"),
        sort: "desc",
        per_page: 100,
      },
    });

    const response = [];

    for await (const item of items) {
      response.push(item);
    }

    response.reverse().forEach(this.emitEvent);
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
H-supertools Analytics Tool	`app`	`app`	This component uses the H-supertools Analytics Tool app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Report Id	`reportId`	`integer`	Select a value from the drop down menu.
Name	`name`	`string`	Select a value from the drop down menu:`browsercampaigncitycontinentcountrydeviceeventlanding_pagelanguageospagepageviewspageviews_hoursreferrerresolutionvisitorsvisitors_hours`

Trigger Authentication#

H-supertools Analytics Tool uses API keys for authentication. When you connect your H-supertools Analytics Tool account, Pipedream securely stores the keys so you can easily authenticate to H-supertools Analytics Tool APIs in both code and no-code steps.

To retrieve your API Key,

Navigate to your H-supertools Analytics Tool account and sign in
Go to “Account” > “API”

About H-supertools Analytics Tool#

Track your visitors in realtime, without compromising their privacy.

Action#

Get Free/Busy Schedule on Microsoft Outlook Calendar

Description:Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. [See the documentation](https://learn.microsoft.com/en-us/graph/api/calendar-getschedule)

Version:0.0.6

Key:microsoft_outlook_calendar-get-schedule

View on GitHub

Microsoft Outlook Calendar Overview#

The Microsoft Outlook Calendar API provides programmatic access to a user's calendar events, allowing for the creation, retrieval, update, and deletion of events within Outlook calendars. With Pipedream, you can integrate these calendar operations into workflows that automate tasks involving scheduling, event management, and coordination with other services. Whether it's triggering actions when new events are created, syncing calendar events with other scheduling tools, or managing attendees, Pipedream's serverless platform enables you to build custom automations with minimal overhead.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
import utils from "../../common/utils.mjs";
import { DateTime } from "luxon";
import { findIana } from "windows-iana";

export default {
  key: "microsoft_outlook_calendar-get-schedule",
  name: "Get Free/Busy Schedule",
  description: "Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. [See the documentation](https://learn.microsoft.com/en-us/graph/api/calendar-getschedule)",
  version: "0.0.6",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    microsoftOutlook,
    schedules: {
      type: "string[]",
      label: "Schedules",
      description: "A list of emails of users, distribution lists, or resources. For example: `[ \"adelev@contoso.com\" , \"meganb@contoso.com\" ]`",
    },
    start: {
      propDefinition: [
        microsoftOutlook,
        "start",
      ],
    },
    end: {
      propDefinition: [
        microsoftOutlook,
        "end",
      ],
    },
    timeZone: {
      propDefinition: [
        microsoftOutlook,
        "timeZone",
      ],
    },
    availabilityViewInterval: {
      type: "integer",
      label: "Availability View Interval",
      description: "Represents the duration of a time slot in minutes in an availabilityView in the response. The default is 30 minutes, minimum is 5, maximum is 1440.",
      optional: true,
    },
  },
  methods: {
    getSchedule(opts = {}) {
      return this.microsoftOutlook._makeRequest({
        method: "POST",
        path: "/me/calendar/getSchedule",
        ...opts,
      });
    },
    convertWorkingHoursToItemTimezone(response) {
      const workingHours = response?.workingHours;

      if (!workingHours) return undefined;

      // Extract the Windows-style names
      const sourceWinTz = workingHours.timeZone.name;
      const targetWinTz = this.timeZone;

      // Convert to IANA time zones
      const sourceIana = findIana(sourceWinTz)?.[0]?.valueOf() || "UTC";
      const targetIana = findIana(targetWinTz)?.[0]?.valueOf() || "UTC";

      const startTime = DateTime.fromISO(`2025-01-01T${workingHours.startTime}`, {
        zone: sourceIana,
      }).setZone(targetIana);

      const endTime = DateTime.fromISO(`2025-01-01T${workingHours.endTime}`, {
        zone: sourceIana,
      }).setZone(targetIana);

      return {
        ...workingHours,
        startTime: startTime.toFormat("HH:mm:ss.SSSSSSS"),
        endTime: endTime.toFormat("HH:mm:ss.SSSSSSS"),
        timeZone: {
          name: targetWinTz,
        },
      };
    },
  },
  async run({ $ }) {
    if (this.schedules === null || this.schedules === undefined || this.schedules?.length === 0) {
      throw new ConfigurationError("The **Schedules** property is required");
    }

    const schedules = utils.parseArray(this.schedules);

    const { value } = await this.getSchedule({
      $,
      data: {
        schedules,
        startTime: {
          dateTime: this.start,
          timeZone: this.timeZone,
        },
        endTime: {
          dateTime: this.end,
          timeZone: this.timeZone,
        },
        availabilityViewInterval: this.availabilityViewInterval,
      },
      headers: {
        Prefer: `outlook.timezone="${this.timeZone}"`,
      },
    });

    if (value?.length > 0 && value[0].workingHours) {
      const convertedHours = this.convertWorkingHoursToItemTimezone(value[0]);
      if (convertedHours) {
        value[0].workingHours = convertedHours;
      }
    }

    $.export("$summary", `Successfully retrieved schedules for \`${schedules.join("`, `")}\``);

    return value;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Microsoft Outlook Calendar	`microsoftOutlook`	`app`	This component uses the Microsoft Outlook Calendar app.
Schedules	`schedules`	`string[]`	A list of emails of users, distribution lists, or resources. For example: `[ "adelev@contoso.com" , "meganb@contoso.com" ]`
Start	`start`	`string`	Start date-time (yyyy-MM-ddThh:mm:ss) e.g. '2022-04-15T11:20:00'
End	`end`	`string`	End date-time (yyyy-MM-ddThh:mm:ss) e.g. '2022-04-15T13:30:00'
Time Zone	`timeZone`	`string`	Select a value from the drop down menu.
Availability View Interval	`availabilityViewInterval`	`integer`	Represents the duration of a time slot in minutes in an availabilityView in the response. The default is 30 minutes, minimum is 5, maximum is 1440.

Action Authentication#

Microsoft Outlook Calendar uses OAuth authentication. When you connect your Microsoft Outlook Calendar account, Pipedream will open a popup window where you can sign into Microsoft Outlook Calendar and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft Outlook Calendar API.

Pipedream requests the following authorization scopes when you connect your account:

User.Reademailoffline_accessopenidprofileCalendars.ReadWrite

About Microsoft Outlook Calendar#

The calendar and scheduling component of Outlook that is fully integrated with email, contacts, and other features

More Ways to Connect Microsoft Outlook Calendar + H-supertools Analytics Tool#

Other Popular Integrations#

Create Calendar Event with Microsoft Outlook Calendar API on New Report Generated from H-supertools Analytics Tool API

H-supertools Analytics Tool + Microsoft Outlook Calendar

Try it

Update Calendar Event with Microsoft Outlook Calendar API on New Report Generated from H-supertools Analytics Tool API

H-supertools Analytics Tool + Microsoft Outlook Calendar

Try it

Delete Calendar Event with Microsoft Outlook Calendar API on New Report Generated from H-supertools Analytics Tool API

H-supertools Analytics Tool + Microsoft Outlook Calendar

Try it

List Events with Microsoft Outlook Calendar API on New Report Generated from H-supertools Analytics Tool API

H-supertools Analytics Tool + Microsoft Outlook Calendar

Try it

Create Report with H-supertools Analytics Tool API on New Calendar Event (Instant) from Microsoft Outlook Calendar API

Microsoft Outlook Calendar + H-supertools Analytics Tool

Try it

Popular Triggers#

New Report Generated from the H-supertools Analytics Tool API

Emit new event when a new analytics report is created.

Try it

New Calendar Event (Instant) from the Microsoft Outlook Calendar API

Emit new event when a new Calendar event is created

Try it

New Calendar Event Update (Instant) from the Microsoft Outlook Calendar API

Emit new event when a Calendar event is updated

Try it

New Upcoming Calendar Event from the Microsoft Outlook Calendar API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it

Popular Actions#

Create Report with the H-supertools Analytics Tool API

Create a new analytics report for a specified website. See the documentation

Try it

Retrieve Report Data with the H-supertools Analytics Tool API

Fetch the analytics report data for a specified website. See the documentation

Try it

Create Calendar Event with the Microsoft Outlook Calendar API

Create an event in the user's default calendar. See the documentation

Try it

Delete Calendar Event with the Microsoft Outlook Calendar API

Delete an event in the user's default calendar. See the documentation

Try it

Get Free/Busy Schedule with the Microsoft Outlook Calendar API

Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. See the documentation

Try it