Run report with Beebole API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Run report with the Beebole 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 Beebole 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 Run report action
1. Connect your Beebole account
2. Configure Start date
3. Configure End date
4. Select one or more Columns
5. Select one or more Status
6. Optional- Select one or more Groups/Custom fields (optional)
7. Optional- Configure Groups to filter results by (optional)
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#

Run report on Beebole

Description:Run a report from Beebole

Version:0.0.1

Key:beebole_app-run-report

View on GitHub

Beebole Overview#

The Beebole API provides a way to automate time tracking, manage projects, and handle employee data efficiently. With Pipedream, you can harness this functionality to create custom workflows that trigger on specific events, manipulate and analyze time tracking data, and integrate with other services for enhanced automation. For instance, you could sync time entries with project management tools, create reports for payroll, or set up alerts based on your team's time tracking patterns.

Action Code#

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

export default {
  name: "Run report",
  description: "Run a report from Beebole",
  key: "beebole_app-run-report",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    begda: {
      propDefinition: [
        app,
        "begda",
      ],
    },
    endda: {
      propDefinition: [
        app,
        "endda",
      ],
    },
    keys: {
      type: "string[]",
      label: "Columns",
      description: "Select the columns to display in the report.",
      options: [
        {
          label: "Absence",
          value: "absence",
        },
        {
          label: "Absence ID",
          value: "absenceId",
        },
        {
          label: "Activity",
          value: "activity",
        },
        {
          label: "Billing",
          value: "billing",
        },
        {
          label: "Billing - %",
          value: "billingPercent",
        },
        {
          label: "Billable - ratio",
          value: "billingRatio",
        },
        {
          label: "Billable/Non-billable",
          value: "billableSplit",
        },
        {
          label: "Billable Utilization %",
          value: "billability",
        },
        {
          label: "Budget",
          value: "budget",
        },
        {
          label: "Business days",
          value: "workDays",
        },
        {
          label: "Business days remaining",
          value: "remWorkDays",
        },
        {
          label: "Business hours",
          value: "workHours",
        },
        {
          label: "Business hours remaining",
          value: "remWorkHours",
        },
        {
          label: "Comment",
          value: "comment",
        },
        {
          label: "Company",
          value: "company",
        },
        {
          label: "Company ID",
          value: "companyId",
        },
        {
          label: "Costs",
          value: "cost",
        },
        {
          label: "Costs - %",
          value: "costsPercent",
        },
        {
          label: "Date",
          value: "date",
        },
        {
          label: "Daily Cost",
          value: "dailyCost",
        },
        {
          label: "Daily Rate",
          value: "dailyRate",
        },
        {
          label: "Days",
          value: "inDays",
        },
        {
          label: "Event ID",
          value: "eventId",
        },
        {
          label: "Hourly Cost",
          value: "hourlyCost",
        },
        {
          label: "Hourly Rate",
          value: "hourlyRate",
        },
        {
          label: "Hours",
          value: "hours",
        },
        {
          label: "Hours - %",
          value: "hoursPercent",
        },
        {
          label: "Is working",
          value: "isAtWork",
        },
        {
          label: "Month",
          value: "month",
        },
        {
          label: "Overtime / day",
          value: "overtime",
        },
        {
          label: "Overtime / week",
          value: "weeklyOvertime",
        },
        {
          label: "Person",
          value: "person",
        },
        {
          label: "Person ID",
          value: "personId",
        },
        {
          label: "Profit",
          value: "profit",
        },
        {
          label: "Profit - %",
          value: "profitPercent",
        },
        {
          label: "Profit - ratio",
          value: "profitRatio",
        },
        {
          label: "Project",
          value: "project",
        },
        {
          label: "Project ID",
          value: "projectId",
        },
        {
          label: "Status",
          value: "status",
        },
        {
          label: "Task",
          value: "task",
        },
        {
          label: "Task ID",
          value: "taskId",
        },
        {
          label: "Time End",
          value: "etime",
        },
        {
          label: "Time Start",
          value: "stime",
        },
        {
          label: "Sub Project",
          value: "subproject",
        },
        {
          label: "Sub Project ID",
          value: "subprojectId",
        },
        {
          label: "Week",
          value: "week",
        },
      ],
      default: [
        "company",
        "project",
        "task",
        "person",
        "hours",
        "comment",
      ],
    },
    statusFilters: {
      type: "string[]",
      label: "Status",
      description: "Choose approval statuses",
      options: [
        {
          label: "Draft",
          value: "d",
        },
        {
          label: "Submitted",
          value: "s",
        },
        {
          label: "Rejected",
          value: "r",
        },
        {
          label: "Approved",
          value: "a",
        },
        {
          label: "Locked",
          value: "l",
        },
      ],
      default: [
        "d",
        "s",
        "a",
        "r",
        "l",
      ],
    },
    groups: {
      type: "string[]",
      label: "Groups/Custom fields (optional)",
      description: "Groups and Custom fields as columns",
      default: [],
      async options() {
        const response = await this.app.apiRequest({
          data: {
            services: [
              {
                service: "group.tree",
              },
              {
                service: "custom_field.list",
              },
            ],
          },
        });
        let opts = [],
          pushGroups = function(v, c, t) {
            v.forEach((i) => {
              let text = t + i.name;
              if (i.groups) {
                c.push({
                  "value": "gid" + i.id,
                  "label": text,
                });
                pushGroups(i.groups, c, text + ": ");
              }
            });
          };
        pushGroups(response[0].groups, opts, "");
        response[1].customFields.forEach((cf) => opts.push({
          "value": "gid" + cf.id,
          "label": cf.name,
        }));

        return opts;
      },
      optional: true,
    },
    groupFilters: {
      type: "integer[]",
      label: "Groups to filter results by (optional)",
      description: "List of groups to filter results. Array of internal IDs i.e. [66]",
      optional: true,
    },
  },
  async run({ $ }) {
    let jobResp,
      response,
      maxWait = 10,
      srvData = {
        service: "time_entry.export",
        from: this.begda,
        to: this.endda,
        show: "all",
        statusFilters: this.statusFilters,
        outputFormat: "array",
      };

    srvData.keys = this.keys.concat(...this.groups);
    if (this.groupFilters && this.groupFilters.length)
      srvData.gids = JSON.parse(this.groupFilters);

    try {
      jobResp = await this.app.apiRequest({
        $,
        data: srvData,
      });
      while (maxWait) {
        response = await this.app.apiRequest({
          $,
          data: {
            service: "time_entry.get_job_info",
            id: jobResp.job.id,
            outputFormat: "array",
          },
        });
        if (response.job.status.indexOf("running") > -1)
          maxWait -= 1;
        else {
          $.export("$summary", `Successfully run report with ${response.job.result.length - 1} results`);
          return response;
        }
      }

      return "Report is taking too long. Stopped. Define additional filters";
    } catch (errors) {
      return errors;
    }
  },
};

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
Beebole	`app`	`app`	This component uses the Beebole app.
Start date	`begda`	`string`	Start date in ISO format (YYYY-MM-DD)
End date	`endda`	`string`	End date in ISO format (YYYY-MM-DD)
Columns	`keys`	`string[]`	Select a value from the drop down menu:`{ "label": "Absence", "value": "absence" }{ "label": "Absence ID", "value": "absenceId" }{ "label": "Activity", "value": "activity" }{ "label": "Billing", "value": "billing" }{ "label": "Billing - %", "value": "billingPercent" }{ "label": "Billable - ratio", "value": "billingRatio" }{ "label": "Billable/Non-billable", "value": "billableSplit" }{ "label": "Billable Utilization %", "value": "billability" }{ "label": "Budget", "value": "budget" }{ "label": "Business days", "value": "workDays" }{ "label": "Business days remaining", "value": "remWorkDays" }{ "label": "Business hours", "value": "workHours" }{ "label": "Business hours remaining", "value": "remWorkHours" }{ "label": "Comment", "value": "comment" }{ "label": "Company", "value": "company" }{ "label": "Company ID", "value": "companyId" }{ "label": "Costs", "value": "cost" }{ "label": "Costs - %", "value": "costsPercent" }{ "label": "Date", "value": "date" }{ "label": "Daily Cost", "value": "dailyCost" }{ "label": "Daily Rate", "value": "dailyRate" }{ "label": "Days", "value": "inDays" }{ "label": "Event ID", "value": "eventId" }{ "label": "Hourly Cost", "value": "hourlyCost" }{ "label": "Hourly Rate", "value": "hourlyRate" }{ "label": "Hours", "value": "hours" }{ "label": "Hours - %", "value": "hoursPercent" }{ "label": "Is working", "value": "isAtWork" }{ "label": "Month", "value": "month" }{ "label": "Overtime / day", "value": "overtime" }{ "label": "Overtime / week", "value": "weeklyOvertime" }{ "label": "Person", "value": "person" }{ "label": "Person ID", "value": "personId" }{ "label": "Profit", "value": "profit" }{ "label": "Profit - %", "value": "profitPercent" }{ "label": "Profit - ratio", "value": "profitRatio" }{ "label": "Project", "value": "project" }{ "label": "Project ID", "value": "projectId" }{ "label": "Status", "value": "status" }{ "label": "Task", "value": "task" }{ "label": "Task ID", "value": "taskId" }{ "label": "Time End", "value": "etime" }{ "label": "Time Start", "value": "stime" }{ "label": "Sub Project", "value": "subproject" }{ "label": "Sub Project ID", "value": "subprojectId" }{ "label": "Week", "value": "week" }`
Status	`statusFilters`	`string[]`	Select a value from the drop down menu:`{ "label": "Draft", "value": "d" }{ "label": "Submitted", "value": "s" }{ "label": "Rejected", "value": "r" }{ "label": "Approved", "value": "a" }{ "label": "Locked", "value": "l" }`
Groups/Custom fields (optional)	`groups`	`string[]`	Select a value from the drop down menu.
Groups to filter results by (optional)	`groupFilters`	`integer[]`	List of groups to filter results. Array of internal IDs i.e. [66]