Get Article with Document360 API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Document360, npm and 2,800+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

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

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Get Article action
1. Connect your Document360 account
2. Select a Project Version ID
3. Select a Article ID
4. Select a Language Code
5. Optional- Configure Is For Display
6. Optional- Configure Is Published
7. Optional- Configure Append SAS Token
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Get Article on Document360

Description:Gets an article from Document360. [See the documentation](https://apidocs.document360.com/apidocs/get-article)

Version:0.0.1

Key:document360-get-article

View on GitHub

Document360 Overview#

The Document360 API enables programmatic interaction with your knowledge base, allowing you to automate content creation, updates, and management. With this API, you can integrate Document360 into your existing content pipelines, support workflows, or any system that needs to push or pull knowledge base content. On Pipedream, you can harness this API to craft serverless workflows that seamlessly integrate with other apps to keep documentation up-to-date, trigger notifications based on content changes, or analyze knowledge base usage.

Action Code#

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

export default {
  key: "document360-get-article",
  name: "Get Article",
  description: "Gets an article from Document360. [See the documentation](https://apidocs.document360.com/apidocs/get-article)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    projectVersionId: {
      propDefinition: [
        app,
        "projectVersionId",
      ],
    },
    articleId: {
      propDefinition: [
        app,
        "articleId",
        ({ projectVersionId }) => ({
          projectVersionId,
        }),
      ],
    },
    langCode: {
      propDefinition: [
        app,
        "langCode",
        ({ projectVersionId }) => ({
          projectVersionId,
        }),
      ],
      default: "en",
    },
    isForDisplay: {
      type: "boolean",
      label: "Is For Display",
      description: "Set this to `true`, if you are displaying the article to the end-user. If `, the content of snippets or variables appears in the article. Note: If the value is true, ensure that the article content is not passed for update article endpoints.",
      optional: true,
    },
    isPublished: {
      type: "boolean",
      label: "Is Published",
      description: "`true` : You will get the latest published version of the article. (If there are no published versions, then it will return the latest version) `false` : To get the the latest version of the article",
      optional: true,
    },
    appendSASToken: {
      type: "boolean",
      label: "Append SAS Token",
      description: "Set this to `false` to exclude appending SAS token for images/files",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      articleId,
      langCode,
      isForDisplay,
      isPublished,
      appendSASToken,
    } = this;

    const response = await app.getArticle({
      $,
      articleId,
      langCode,
      params: {
        isForDisplay,
        isPublished,
        appendSASToken,
      },
    });

    $.export("$summary", `Successfully retrieved article ID \`${articleId}\` (${langCode})`);
    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
Document360	`app`	`app`	This component uses the Document360 app.
Project Version ID	`projectVersionId`	`string`	Select a value from the drop down menu.
Article ID	`articleId`	`string`	Select a value from the drop down menu.
Language Code	`langCode`	`string`	Select a value from the drop down menu.
Is For Display	`isForDisplay`	`boolean`	Set this to `true`, if you are displaying the article to the end-user. If `, the content of snippets or variables appears in the article. Note: If the value is true, ensure that the article content is not passed for update article endpoints.
Is Published	`isPublished`	`boolean`	`true` : You will get the latest published version of the article. (If there are no published versions, then it will return the latest version) `false` : To get the the latest version of the article
Append SAS Token	`appendSASToken`	`boolean`	Set this to `false` to exclude appending SAS token for images/files