Perform Search with SERPhouse API on New Field in Document from MongoDB API

Pipedream makes it easy to connect APIs for SERPhouse, MongoDB and 3,000+ other apps remarkably fast.

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

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

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Perform Search action
1. Connect your SERPhouse account
2. Configure Query
3. Select a Domain
4. Select a Language
5. Select a Device
6. Select a SERP Type
7. Configure locationAlert
8. Optional- Select a Location
9. Optional- Configure Verbatim
10. Optional- Configure GFilter
11. Optional- Configure Page
12. Optional- Configure Number of Results
13. Optional- Select a Date Range
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 Field in Document on MongoDB

Description:Emit new an event when a new field is added to a document

Version:0.0.7

Key:mongodb-new-field-in-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.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "mongodb-new-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        ts,
      };
    },
  },
};

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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
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.

Trigger 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.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Perform Search on SERPhouse

Description:Performs a search using the Serphouse API. [See the documentation](https://docs.serphouse.com/serp-api/live-using-http-get-method)

Version:0.0.1

Key:serphouse-perform-search

View on GitHub

SERPhouse Overview#

The SERPhouse API provides a way to fetch real-time search engine results pages (SERPs) from Google and Bing. With it, you can gather SEO data, monitor keyword rankings, and gain insights into search trends. On Pipedream, you can leverage this API to build serverless workflows that automate SEO tasks, conduct competitive analysis, and integrate with other apps to enhance your digital marketing strategies.

Action Code#

import serphouse from "../../serphouse.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "serphouse-perform-search",
  name: "Perform Search",
  description: "Performs a search using the Serphouse API. [See the documentation](https://docs.serphouse.com/serp-api/live-using-http-get-method)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    serphouse,
    query: {
      propDefinition: [
        serphouse,
        "query",
      ],
    },
    domain: {
      propDefinition: [
        serphouse,
        "domain",
      ],
    },
    language: {
      propDefinition: [
        serphouse,
        "language",
        ({ domain }) => ({
          domain,
        }),
      ],
    },
    device: {
      type: "string",
      label: "Device",
      description: "The device to use for the search",
      options: [
        "desktop",
        "tablet",
        "mobile",
      ],
    },
    serpType: {
      type: "string",
      label: "SERP Type",
      description: "The type of SERP to use for the search",
      options: [
        "web",
        "news",
        "image",
      ],
    },
    locationAlert: {
      propDefinition: [
        serphouse,
        "locationAlert",
      ],
    },
    locationId: {
      propDefinition: [
        serphouse,
        "locationId",
        ({ domain }) => ({
          domain,
        }),
      ],
      optional: true,
    },
    verbatim: {
      type: "boolean",
      label: "Verbatim",
      description: "If true, the search will be performed verbatim",
      optional: true,
    },
    gfilter: {
      type: "boolean",
      label: "GFilter",
      description: "Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `true` (default) to enable these filters, or `false` to disable these filters.",
      optional: true,
      default: true,
    },
    page: {
      type: "integer",
      label: "Page",
      description: "Give specific page to get the result of that page number. By default it will get you first page",
      optional: true,
    },
    numResults: {
      type: "integer",
      label: "Number of Results",
      description: "Define number of result you want to get per page. By default you will get top 100 results.",
      optional: true,
    },
    dateRange: {
      propDefinition: [
        serphouse,
        "dateRange",
      ],
    },
  },
  async run({ $ }) {
    const type = this.serphouse.getDomainType(this.domain);
    if (!this.locationId && (type === "google" || type === "bing")) {
      throw new ConfigurationError("Location is required for Google and Bing searches");
    }
    const response = await this.serphouse.performSearch({
      $,
      params: {
        q: this.query,
        domain: this.domain,
        lang: this.language,
        device: this.device,
        serp_type: this.serpType,
        loc_id: this.locationId,
        verbatim: this.verbatim
          ? "1"
          : "0",
        gfilter: this.gfilter
          ? "1"
          : "0",
        page: this.page,
        num_result: this.numResults,
        date_range: this.dateRange,
      },
    });
    if (response.status === "success") {
      $.export("$summary", `Successfully performed search for "${this.query}".`);
    }
    return response;
  },
};

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
SERPhouse	`serphouse`	`app`	This component uses the SERPhouse app.
Query	`query`	`string`	Search phrase that you want to search
Domain	`domain`	`string`	Select a value from the drop down menu.
Language	`language`	`string`	Select a value from the drop down menu.
Device	`device`	`string`	Select a value from the drop down menu:`desktoptabletmobile`
SERP Type	`serpType`	`string`	Select a value from the drop down menu:`webnewsimage`
Location	`locationId`	`string`	Select a value from the drop down menu.
Verbatim	`verbatim`	`boolean`	If true, the search will be performed verbatim
GFilter	`gfilter`	`boolean`	Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to `true` (default) to enable these filters, or `false` to disable these filters.
Page	`page`	`integer`	Give specific page to get the result of that page number. By default it will get you first page
Number of Results	`numResults`	`integer`	Define number of result you want to get per page. By default you will get top 100 results.
Date Range	`dateRange`	`string`	Select a value from the drop down menu:`{ "label": "Past hour", "value": "h" }{ "label": "Past 24 hours", "value": "d" }{ "label": "Past week", "value": "w" }{ "label": "Past month", "value": "m" }{ "label": "Past year", "value": "y" }`