Delete a Document with MongoDB API on New Analysis Complete from Insites API

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

Trigger workflow on

New Analysis Complete from the Insites API

Next, do this

Delete a Document with the MongoDB 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 MongoDB 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 Delete a Document action
1. Connect your MongoDB account
2. Select a Database
3. Select a Collection
4. Select a Document
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#

Delete a Document on MongoDB

Description:Delete a single document by ID. [See the docs here](https://docs.mongodb.com/manual/tutorial/remove-documents/)

Version:0.1.5

Key:mongodb-delete-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Action Code#

import mongodbApp from "../../mongodb.app.mjs";

export default {
  key: "mongodb-delete-document",
  name: "Delete a Document",
  description: "Delete a single document by ID. [See the docs here](https://docs.mongodb.com/manual/tutorial/remove-documents/)",
  version: "0.1.5",
  type: "action",
  props: {
    mongodbApp,
    database: {
      propDefinition: [
        mongodbApp,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        mongodbApp,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        mongodbApp,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  async run({ $ }) {
    await this.mongodbApp.deleteDocumentById(
      this.database,
      this.collection,
      this.document,
    );
    $.export("$summary", `Document "${this.document}" successfully deleted`);
  },
};

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
MongoDB	`mongodbApp`	`app`	This component uses the MongoDB app.
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Select a value from the drop down menu.

Action Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

Delete a Document with MongoDB API on New Analysis Complete from Insites API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular