Use Auto Update to Add New URL’s
May 28, 2019
June 2019 Updates & Fixes
June 24, 2019

Setting up Deep Crawl API

Search Knowledge Base by Keyword

You are here:

If you use Deep Crawl for SEO Diagnostics you can use those crawls to create a validated list of URL’s to be imported into HREFLang Builder. To complete your set up we need a few things from you. This page does not tell you how to set up the API for your use but how to get the information we need to use it on your behalf.

Please review the requirements and considerations for using the API.

Step 1 – Create your API Token (Key)

To create your API click the Admin option for the name of your account and choose the API access.

  1. Create your API Token by clicking the button “Generate New API Key which will popup a window with the API token.
  2. Copy your Key ID since you will need to provide it as well. It is blurred on purpose for this screen capture.

You need to copy this full number and save in a txt or some other file or copy directly into HREFLang Builder Using Step below.

Make sure you have a copy saved locally since this key will not generate again. You will have to delete it and start again.

Step 2 – Copy your Account ID

Directly below the API key section you can find your account ID. You will need this number. It is blurred in the screen capture for security purposes. You can also get it from the project URL during step 3.

Step 3 – Copy Project ID’s

This step will vary based on how you have set up Deep Crawl to crawl the country sites.

Single Global Project

If you have only one project where you crawl all of your country sites at one time it is easier to copy the project ID and add it directly to HREFLang Builder. If you later add additional projects you will need to update the config for multiple projects.

Click the dashboard for your project and in the address bar it will have the project ID. Copy this ID for the config process.

Multiple Projects

If you have created a crawl project for all or most of your countries we can pull them in via the API and need to set that in the config process.

Step 4 – Create/Edit Auto Update Task

Once you have the items above, log into HREFLang Builder. if you have an Auto Load job set up currently jump to the next step. If you do not follow these steps to create a new Auto Update job.

Step 5 – Configure HREFLang Builder for API Connections

This is where you add all of the information from the previous steps to the admin section in Auto Updates.

  1. Click the Deep Crawl Tab to open the API configuration box
  2. Paste your API Key ID from Step 1
  3. Paste your API Key from Step 1
  4. Paste your Account ID from Step 2
  5. Select the priority of the DeepCrawl files – select the option best for you
  1. Ignore other URL’s will not import aURL’s from any other sources. This ensures only the validated URL’s from DeepCrawl are imported.
  2. Check other URL’s – this is the default option and will pull in URL’s from any other source listed in the auto loader. Note, all URL’s will be treated equally and if error checking is not set you may be importing non-validated URL’s.

6. After Adding these three items, the screen will change after connecting to Deep Crawl with a list of all of your active projects. Click the pull down to show the list of available projects.

Select all of the project(s) you wish to have imported into the system. These can be individual projects for each country/language or a master project of all URl’s for all countries.

If you have any issues with setting this up please complete a help ticket. For any assistance with DeepCrawl access or active accounts please contact your DeepCrawl account representative.