Search Documents with MongoDB API on New Article Published from New York Times API

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

Trigger workflow on

New Article Published from the New York Times API

Next, do this

Search Documents 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 New York Times 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 Article Published trigger
1. Connect your New York Times account
2. Configure timer
3. Optional- Configure Facet
4. Optional- Select one or more Facet Fields
5. Optional- Configure Facet Filter
6. Optional- Configure Field List
7. Optional- Configure Filtered Query
8. Optional- Configure Query
9. Configure alert
Configure the Search Documents action
1. Connect your MongoDB account
2. Select a Database
3. Select a Collection
4. Optional- Configure Filter
5. Optional- Configure Options
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 Article Published on New York Times

Description:Emit new event when an article is published.

Version:0.0.1

Key:new_york_times-new-article

View on GitHub

New York Times Overview#

The New York Times API offers a variety of endpoints to access different types of news and information. With Pipedream, you can tap into this wealth of data to automate tasks, enrich applications with the latest news, or even analyze trends. Workflows on Pipedream triggered by NYT's API can range from sending daily news briefings to your communication platform, to analyzing article metadata for SEO research, or even keeping track of the most popular stories for content curation.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import app from "../../new_york_times.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "new_york_times-new-article",
  name: "New Article Published",
  description: "Emit new event when an article is published.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    facet: {
      type: "boolean",
      label: "Facet",
      description: "Whether to show facet counts.",
      optional: true,
    },
    facetFields: {
      type: "string[]",
      label: "Facet Fields",
      description: "Use facets to view the relative importance of certain fields to a search term, and gain insight about how to best refine your queries and filter your search results.",
      options: [
        "day_of_week",
        "document_type",
        "ingredients",
        "news_desk",
        "pub_month",
        "pub_year",
        "section_name",
        "source",
        "subsection_name",
        "type_of_material",
      ],
      optional: true,
    },
    facetFilter: {
      type: "boolean",
      label: "Facet Filter",
      description: "Have facet counts use filters.",
      optional: true,
    },
    fl: {
      type: "string[]",
      label: "Field List",
      description: "The list of fields to return in the result set.",
      optional: true,
    },
    fq: {
      type: "string",
      label: "Filtered Query",
      description: "A query to filter the search results.",
      optional: true,
    },
    q: {
      type: "string",
      label: "Query",
      description: "Search query term. Search is performed on the article body, headline, and byline.",
      optional: true,
    },
    alert: {
      type: "alert",
      alertType: "info",
      content: "To learn more about filters you can download the [New York Times specification here](https://developer.nytimes.com/portals/api/sites/nyt-devportal/liveportal/apis/articlesearch-product/download_spec).",
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || moment().subtract(1, "day");
    },
    _setLastDate(created) {
      this.db.set("lastDate", created);
    },
    generateMeta(item) {
      return {
        id: item._id,
        summary: `A new article was just published with Id: ${item._id}.`,
        ts: item.pub_date,
      };
    },
    async startEvent(maxResults = 0) {
      const lastDate = this._getLastDate();

      const data = this.app.paginate({
        fn: this.app.searchArticles,
        maxResults,
        params: {
          begin_date: moment(lastDate).format("YYYYMMDD"),
          facet: this.facet,
          facet_fields: this.facetFields && this.facetFields.join(),
          facet_filter: this.facetFilter,
          fl: this.fl && this.fl.join(),
          fq: this.fq,
          q: this.q,
          sort: "newest",
        },
      });

      const responseArray = [];
      for await (const item of data) {
        if (Date.parse(item.pub_date) <= Date.parse(lastDate)) break;
        responseArray.push(item);
      }

      if (responseArray.length) this._setLastDate(responseArray[0].pub_date);

      for (const item of responseArray.reverse()) {
        this.$emit(item, this.generateMeta(item));
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
New York Times	`app`	`app`	This component uses the New York Times app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Facet	`facet`	`boolean`	Whether to show facet counts.
Facet Fields	`facetFields`	`string[]`	Select a value from the drop down menu:`day_of_weekdocument_typeingredientsnews_deskpub_monthpub_yearsection_namesourcesubsection_nametype_of_material`
Facet Filter	`facetFilter`	`boolean`	Have facet counts use filters.
Field List	`fl`	`string[]`	The list of fields to return in the result set.
Filtered Query	`fq`	`string`	A query to filter the search results.
Query	`q`	`string`	Search query term. Search is performed on the article body, headline, and byline.

Trigger Authentication#

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

About New York Times#

The New York Times is an American daily newspaper which features top articles across many sections, including politics, technology, and opinion.

Action#

Search Documents on MongoDB

Description:Search for specific documents or return all documents. [See the docs here](https://docs.mongodb.com/manual/reference/method/db.collection.find/)

Version:0.0.8

Key:mongodb-search-documents

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-search-documents",
  name: "Search Documents",
  description: "Search for specific documents or return all documents. [See the docs here](https://docs.mongodb.com/manual/reference/method/db.collection.find/)",
  version: "0.0.8",
  type: "action",
  props: {
    mongodbApp,
    database: {
      propDefinition: [
        mongodbApp,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        mongodbApp,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    filter: {
      label: "Filter",
      description: "Object to use as a filter. Values will be interpreted as strings. To pass a number, boolean, array, or object, wrap the value in an expression. eg. `{{1}}`",
      type: "object",
      optional: true,
    },
    options: {
      label: "Options",
      description: "Additional props for sorting and ordering. [See docs](https://www.mongodb.com/docs/drivers/node/current/usage-examples/find/)",
      type: "object",
      optional: true,
    },
  },
  async run({ $ }) {
    const documents = await this.mongodbApp.searchDocuments(
      this.database,
      this.collection,
      this.filter,
      this.options,
    );

    $.export("$summary", `Successfully retrieved ${documents.length} document(s)`);
    return documents;
  },
};

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.
Filter	`filter`	`object`	Object to use as a filter. Values will be interpreted as strings. To pass a number, boolean, array, or object, wrap the value in an expression. eg. `{{1}}`
Options	`options`	`object`	Additional props for sorting and ordering. See docs

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.

Search Documents with MongoDB API on New Article Published from New York Times API

Pipedream makes it easy to connect APIs for MongoDB, New York Times 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