Get Backlinks One Per Domain with Ahrefs API on New Modified Linked Reference from Roam Research API

Pipedream makes it easy to connect APIs for Ahrefs, Roam Research and 2,400+ other apps remarkably fast.

Trigger workflow on

New Modified Linked Reference from the Roam Research API

Next, do this

Get Backlinks One Per Domain with the Ahrefs 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 Roam Research trigger and Ahrefs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Modified Linked Reference trigger
1. Connect your Roam Research account
2. Configure Polling Schedule
3. Select a Resource Type
4. Configure Page Title Or Block UID
Configure the Get Backlinks One Per Domain action
1. Connect your Ahrefs account
2. Configure target
3. Optional- Select a mode
4. Optional- Configure limit
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 Modified Linked Reference on Roam Research

Description:Emit new event for each new or modified linked reference in Roam Research.

Version:0.0.1

Key:roamresearch-new-modified-linked-reference

View on GitHub

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import app from "../../roamresearch.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "roamresearch-new-modified-linked-reference",
  name: "New Modified Linked Reference",
  description: "Emit new event for each new or modified linked reference in Roam Research.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      label: "Polling Schedule",
      description: "How often to poll the API",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    resourceType: {
      propDefinition: [
        app,
        "resourceType",
      ],
    },
    pageOrBlock: {
      propDefinition: [
        app,
        "pageOrBlock",
      ],
    },
  },
  methods: {
    getResourcesName() {
      return "result.:block/_refs";
    },
    getResourcesFn() {
      return this.app.pull;
    },
    getResourcesFnArgs() {
      const {
        resourceType,
        pageOrBlock,
      } = this;

      const attribute = resourceType === "page"
        ? ":node/title"
        : ":block/uid";

      return {
        data: {
          selector: `[${attribute} :block/string :block/order :edit/time {:block/_refs ...}]`,
          eid: `[${attribute} "${pageOrBlock}"]`,
        },
      };
    },
    generateMeta(resource) {
      const ts = resource[":edit/time"];
      return {
        id: ts,
        summary: `Link Reference: ${resource[":block/string"]}`,
        ts,
      };
    },
    processResource(resource) {
      const meta = this.generateMeta(resource);
      this.$emit(resource, meta);
    },
  },
  async run() {
    const {
      getResourcesFn,
      getResourcesName,
      getResourcesFnArgs,
      processResource,
    } = this;

    const resourcesFn = getResourcesFn();
    const response = await resourcesFn(getResourcesFnArgs());
    const resources = utils.getNestedProperty(response, getResourcesName());

    if (!resources) {
      console.log("No resources found");
      return;
    }

    Array.from(resources)
      .reverse()
      .forEach(processResource);
  },
};

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
Roam Research	`app`	`app`	This component uses the Roam Research app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Schedule	`timer`	`$.interface.timer`	How often to poll the API
Resource Type	`resourceType`	`string`	Select a value from the drop down menu:`pageblock`
Page Title Or Block UID	`pageOrBlock`	`string`	The page title of the block uid to get data for. Page title example: `My Page` and Block UID example: `ideWWvTgI`.

Trigger Authentication#

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

About Roam Research#

A note-taking tool for networked thought.

Action#

Get Backlinks One Per Domain on Ahrefs

Description:Get one backlink with the highest `ahrefs_rank` per referring domain for a target URL or domain (with details for the referring pages including anchor and page title).

Version:0.0.5

Key:ahrefs-get-backlinks-one-per-domain

View on GitHub

Ahrefs Overview#

Ahrefs API taps into the vast data reserves of Ahrefs, a robust SEO tool, to programmatically access insights into backlink profiles, keyword rankings, and SEO health. With Pipedream's capabilities, you can automate SEO monitoring, integrate with content management systems, trigger alerts for new or lost backlinks, or gather intelligence for keyword research—all without manual intervention. This unlocks the potential for real-time SEO strategy adjustments and the integration of SEO data into broader business processes or analytics platforms.

Action Code#

const ahrefs = require("../../ahrefs.app.js");
const axios = require("axios");

module.exports = {
  name: "Get Backlinks One Per Domain",
  key: "ahrefs-get-backlinks-one-per-domain",
  description: "Get one backlink with the highest `ahrefs_rank` per referring domain for a target URL or domain (with details for the referring pages including anchor and page title).",
  version: "0.0.5",
  type: "action",
  props: {
    ahrefs,
    target: {
      propDefinition: [
        ahrefs,
        "target",
      ],
    },
    mode: {
      propDefinition: [
        ahrefs,
        "mode",
      ],
    },
    limit: {
      propDefinition: [
        ahrefs,
        "limit",
      ],
    },
  },
  async run() {
    return (await axios({
      url: "https://apiv2.ahrefs.com",
      params: {
        token: this.ahrefs.$auth.oauth_access_token,
        from: "backlinks_one_per_domain",
        target: this.target,
        mode: this.mode,
        limit: this.limit,
        order_by: "ahrefs_rank:desc",
        output: "json",
      },
    })).data;
  },
};

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
Ahrefs	`ahrefs`	`app`	This component uses the Ahrefs app.
target	`target`	`string`	Enter a domain or URL.
mode	`mode`	`string`	Select a value from the drop down menu:`{ "label": "Exact", "value": "exact" }{ "label": "Domain", "value": "domain" }{ "label": "Subdomain", "value": "subdomains" }{ "label": "Prefix", "value": "prefix" }`
limit	`limit`	`integer`	Number of results to return.

Action Authentication#

Ahrefs uses OAuth authentication. When you connect your Ahrefs account, Pipedream will open a popup window where you can sign into Ahrefs and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Ahrefs API.

Pipedream requests the following authorization scopes when you connect your account:

api