Skip to main content

What are deep links?

Derry CoffeySoftware Engineer
19 July 2023

Deep linking is a valuable feature provided by Insytful, designed to enhance your content management experience by seamlessly connecting your Insytful page reports with the corresponding editing page in your Content Management System (CMS).

By utilising metadata from your webpages and customisable templates, deep linking empowers you to navigate directly to specific pieces of content within your CMS, facilitating efficient editing and issue resolution.

Deep linking simplifies the process of moving from page analysis and reporting in Insytful to editing content in your CMS. Whether you are reviewing performance, accessibility, content quality, or SEO scores within Insytful, deep linking allows you to seamlessly transition to the relevant editing page in your CMS with just a single click. This streamlined workflow eliminates the need for manual searches within the CMS, enabling you to promptly address any identified issues or make necessary updates.

Setting up deep linking can be a relatively simple task. See our guide below to learn about setting up templates and deep link metadata.

How do I set up CMS deep linking for Insytful?

Deep link Template

Your deep link template is the foundation for your CMS integration. You will first need to identify the URL's that your CMS uses for editing content e.g.

  • Contensis: https://cms-mysite.cloud.contensis.com/app/projects/website/entries/12345678-1234-1234-1234-012345678901
  • WordPress: https://www.mysite.com/wp-admin/post.php?post=1&action=edit
  • Drupal: https://www.mysite.com/node/1/edit

Once you know the format for your edit page, you need to identify the parts of the URL that determine what content you are editing e.g.

  • Contensis: https://cms-mysite.cloud.contensis.com/app/projects/website/entries/12345678-1234-1234-1234-012345678901
  • WordPress: https://www.mysite.com/wp-admin/post.php?post=1&action=edit
  • Drupal: https://www.mysite.com/node/1/edit

You're now ready to create your deep link template.

For each part of your URL that can be changed, decide on a token name to represent that value e.g.

  • Contensis: ProjectId, EntryId
  • WordPress: PostId
  • Drupal: NodeId

You can now replace the values in your edit URL with these tokens by putting them in square brackets, like so:

  • Contensis: https://cms-mysite.cloud.contensis.com/app/projects/[ProjectId]/entries/[EntryId]
  • WordPress: https://www.mysite.com/wp-admin/post.php?post=[PostId]&action=edit
  • Drupal: https://www.mysite.com/node/[NodeId]/edit

You're now ready to prepare your metadata that will be used to replace these tokens.

Deep link Meta

In your page templates, you will want to include some meta tags using Insytful's "IDL" (Insytful deep link) format.

Example:

TSX
1
<meta name="IDL:ProjectId" content="website">

The format is relatively simple - The name should start with "IDL" followed by a colon and then your token name. The content is the value for that particular token on the given page.

Wrap up - How deep links work in Insytful

Once you've added these to the page template and populated them with the relevant data from your CMS you're ready to go!

On your next scan Insytful will pick up the IDL metadata from the tags and populate the CMS URL - Providing a link directly to your website.

Derry CoffeySoftware Engineer