Get Component with Pipedream API on New Analysis Complete from Insites API

Pipedream makes it easy to connect APIs for Pipedream, Insites and 2,400+ other apps remarkably fast.

Trigger workflow on

New Analysis Complete from the Insites API

Next, do this

Get Component with the Pipedream 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 Insites trigger and Pipedream action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Analysis Complete trigger
1. Connect your Insites account
2. Configure timer
3. Optional- Configure Filter
4. Optional- Configure Include Historic
5. Optional- Configure List ID
Configure the Get Component action
1. Connect your Pipedream account
2. Configure Component Key
3. Optional- Configure Pipedream Registry
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 Analysis Complete on Insites

Description:Emit new event when a new analysis is completed. [See the documentation](https://help.insites.com/en/articles/7994946-report-api#h_e59622a8e7)

Version:0.0.2

Key:insites-analysis-complete

View on GitHub

Insites Overview#

The Insites API offers a suite of tools for website testing and monitoring, enabling users to automate the process of checking website quality, performance, and compliance with SEO and accessibility standards. With Pipedream, you can harness this API to create workflows that trigger on events across your apps, perform actions based on website analysis results, and automate repetitive tasks that ensure your website maintains high standards for your users.

Trigger Code#

import {
  ConfigurationError,
  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
} from "@pipedream/platform";
import app from "../../insites.app.mjs";

export default {
  dedupe: "unique",
  type: "source",
  key: "insites-analysis-complete",
  name: "New Analysis Complete",
  description: "Emit new event when a new analysis is completed. [See the documentation](https://help.insites.com/en/articles/7994946-report-api#h_e59622a8e7)",
  version: "0.0.2",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    filter: {
      type: "string",
      label: "Filter",
      description: "JSON encoded string - attributes by which the reports should be filtered by. [See the documentation for more details](https://help.insites.com/en/articles/7994946-report-api#h_e59622a8e7). Example: `[{\"operator\":\"equal\",\"property\":\"mobile.is_mobile\",\"targetValue\":false}]`",
      optional: true,
    },
    includeHistoric: {
      type: "boolean",
      label: "Include Historic",
      description: "Whether the results should contain old versions of the business reports.",
      optional: true,
    },
    listId: {
      type: "string",
      label: "List ID",
      description: "Will filter the results and return only those in the given list. Note: list ID should be the 32-character hexadecimal ID provided by Insites (not the list name which is assigned by the user).",
      optional: true,
    },
  },
  methods: {
    setLastExecutionTime(time) {
      this.db.set("lastExecutionTime", time);
    },
    getLastExecutionTime() {
      const lastExecutionTime = this.db.get("lastExecutionTime");
      if (!lastExecutionTime) {
        const YESTERDAY = 86400000;
        return new Date(Date.now() - YESTERDAY).toISOString();
      }
      return new Date(lastExecutionTime).toISOString();
    },
    validateJsonString(obj) {
      if (typeof obj !== "string") {
        return obj;
      }
      try {
        return JSON.parse(obj);
      } catch (err) {
        throw new ConfigurationError("Filter must be a valid JSON string.");
      }
    },
    emitEvent(report) {
      const meta = this.generateMeta(report);
      this.$emit(report, meta);
    },
    generateMeta(report) {
      return {
        id: report.report_id,
        summary: report.domain,
        ts: report.meta.report_completed_at,
      };
    },
  },
  async run() {
    let userFilter = [];
    if (this.filter) {
      userFilter = this.validateJsonString(this.filter);
    }
    const lastExecutionTime = this.getLastExecutionTime();
    const filter = [
      {
        "property": "report.meta.report_completed_at",
        "operator": "more_than",
        "targetValue": lastExecutionTime,
        "numeric": "false",
      },
    ];

    const data = [];
    const LIMIT = 100;
    let offset = 0;
    while (true) {
      const res = await this.app.searchAllReports({
        filter: JSON.stringify(filter.concat(userFilter)),
        offset,
        limit: LIMIT,
        include_historic: this.includeHistoric,
        list_id: this.listId,
      });
      if (!res.reports || res.reports.length === 0) {
        break;
      }
      data.push(...res.reports);
      offset += LIMIT;
    }

    for (const report of data.reverse()) {
      this.emitEvent(report);
    }
  },
};

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
Insites	`app`	`app`	This component uses the Insites app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Filter	`filter`	`string`	JSON encoded string - attributes by which the reports should be filtered by. See the documentation for more details. Example: `[{"operator":"equal","property":"mobile.is_mobile","targetValue":false}]`
Include Historic	`includeHistoric`	`boolean`	Whether the results should contain old versions of the business reports.
List ID	`listId`	`string`	Will filter the results and return only those in the given list. Note: list ID should be the 32-character hexadecimal ID provided by Insites (not the list name which is assigned by the user).

Trigger Authentication#

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

About Insites#

Insites lets you audit any website's online presence in under 60 seconds.

Action#

Get Component on Pipedream

Description:Get info for a published component. [See docs](https://pipedream.com/docs/api/rest/#get-a-component)

Version:0.1.0

Key:pipedream-get-component

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

import pipedream from "../../pipedream.app.mjs";

export default {
  key: "pipedream-get-component",
  name: "Get Component",
  description: "Get info for a published component. [See docs](https://pipedream.com/docs/api/rest/#get-a-component)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    componentKey: {
      propDefinition: [
        pipedream,
        "componentKey",
      ],
    },
    globalRegistry: {
      type: "boolean",
      label: "Pipedream Registry",
      description: "Defaults to `true`. If set to `true`, this will fetch component data from the public Pipedream registry. Set to `false` to search your private published components.",
      optional: true,
      default: true,
    },
  },
  async run({ $ }) {
    const { data } = await this.pipedream.getComponent(this.componentKey, this.globalRegistry);

    if (data) {
      $.export("$summary", `Succesfully fetched ${this.componentKey}`);
      return data;
    }

    console.log(`${this.componentKey} was not found`);
  },
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Component Key	`componentKey`	`string`	The component key (identified by the key property within the component's source code) you'd like to fetch metadata for (example: `github-new-commit-instant`)
Pipedream Registry	`globalRegistry`	`boolean`	Defaults to `true`. If set to `true`, this will fetch component data from the public Pipedream registry. Set to `false` to search your private published components.

Action Authentication#

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

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Insites#

Other Popular Integrations#

Analyze Business with Insites API on New Scheduled Tasks from Pipedream API

Pipedream + Insites

Try it

Create a Subscription with Pipedream API on New Analysis Complete from Insites API

Insites + Pipedream

Try it

Delete a Subscription with Pipedream API on New Analysis Complete from Insites API

Insites + Pipedream

Try it

Generate Component Code with Pipedream API on New Analysis Complete from Insites API

Insites + Pipedream

Try it

Popular Triggers#

New Analysis Complete from the Insites API

Emit new event when a new analysis is completed. See the documentation

Try it

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream 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