Run an SEO Report

GET https://restapi.actonsoftware.com/api/1/seoreport

This endpoint allows you to run an SEO report on the URL that you specify.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: Header False Required String Insert your generated access token.
("Bearer {access token}")
keyword Query False Required String Specify a keyword for the SEO report.
url Query False Required String Specify a URL encoded URL.

Response

{
  "score": 72,
  "titleResults": {
    "score": 22,
    "counts": {
      "warning": 1,
      "error": 0,
      "good": 2
    },
    "rules": [
      {
        "icon": "goodIcon",
        "description": "This is a good length for a page title. It is long enough to inform searchers and search engines what a page is about, and short enough that key concepts won't be cropped by the search engines.",
        "title": "The title is between 8 and 55 characters"
      },
      {
        "icon": "warningIcon",
        "description": "Research shows that the first 10 characters determine whether someone continues to read on - or not. Best practice is to use the keyword starting in the first 10 characters (including spaces) of the title.",
        "title": "The keyword doesn't start in the first 10 characters of the title"
      },
      {
        "icon": "goodIcon",
        "description": "It's good to use keywords just once in the title. This gives you additional space to communicate to search engines and searchers what the page is about, without running the risk of your page being perceived as spam.",
        "title": "The keywords are used just once in the title"
      }
    ]
  },
  "bodyResults": {
    "score": 30,
    "counts": {
      "warning": 0,
      "error": 0,
      "good": 3
    },
    "rules": [
      {
        "icon": "goodIcon",
        "description": "This page is a good length. It's long enough that you should have plenty of opportunities to share information and use the keyword effectively.",
        "title": "Body copy is longer than 300 words"
      },
      {
        "icon": "goodIcon",
        "description": "Using all of the words in the keyword in exactly the same order as you defined them in the Keywords tab, at least once in the body of your page, is good. The more you use the keywords (with well written, customer-friendly, natural language) the better your chances this page will rank.",
        "title": "The keyword is used in the exact order in the body copy"
      },
      {
        "icon": "goodIcon",
        "description": "It's good that the keyword appears at least 4 times in the body copy of this page. The more you use the keywords (with well written, customer-friendly, natural language) the better your chances this page will rank.",
        "title": "The keyword is used 4 or more times in the body copy"
      }
    ]
  },
  "counts": {
    "warning": 7,
    "error": 2,
    "good": 18
  },
  "descriptionResults": {
    "score": 11,
    "counts": {
      "warning": 1,
      "error": 0,
      "good": 2
    },
    "rules": [
      {
        "icon": "warningIcon",
        "description": "Search engines will index up to 255 characters (including spaces) of the page description, but anything over 150 characters (including spaces) will be hidden from searchers and unable to influence which search result they choose. They will see only an ellipsis (...).",
        "title": "The description is longer than 150 characters"
      },
      {
        "icon": "goodIcon",
        "description": "You have created a description that will help searchers and understand what the page is about.",
        "title": "The description contains the keyword"
      },
      {
        "icon": "goodIcon",
        "description": "It is good to use the keyword just once in the description. This allows you to communicate to searchers what the page is about, without running the risk of your page being perceived as spam.",
        "title": "The keyword is used just once in the description"
      }
    ]
  },
  "h1Results": {
    "h1tag": "maximize your nmarketing potential",
    "score": 6,
    "additionalH1": [],
    "counts": {
      "warning": 1,
      "error": 0,
      "good": 2
    },
    "rules": [
      {
        "icon": "goodIcon",
        "description": "This is a good length for a H1 heading.",
        "title": "The H1 heading is shorter than 55 characters"
      },
      {
        "icon": "warningIcon",
        "description": "It's best to use the keyword starting in the first 10 characters of the H1 heading, but don't sacrifice a great heading to force this.",
        "title": "The keyword doesn't start in the first 10 characters of the heading"
      },
      {
        "icon": "goodIcon",
        "description": "It is good to only use the keyword once in the heading. This allows you to communicate to search engines and searchers what the page is about, without running the risk of your page being perceived as spam.",
        "title": "The keyword is used just once in the heading"
      }
    ]
  },
  "altTagResults": {
    "altTags": [
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2016/04/Act-On_logo-2016_two-tone.png",
        "checkDisabled": false,
        "counts": {
          "warning": 1,
          "error": 0,
          "good": 1
        },
        "rules": [
          {
            "icon": "goodIcon",
            "description": "It's good that this image has an alt tag. Alt text helps search engines understand what the image is about. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "This image has an alt tag"
          },
          {
            "icon": "warningIcon",
            "description": "It's good to use your keyword in the alt text of your images when it makes sense. The alt text is a short "stand in" in the event that the image itself is not available, so you can skip including the keyword if it isn't the best way to describe the image. For images that play only a decorative role in the page, use an empty alt (i.e. alt="").",
            "title": "This image doesn't have the keyword in the alt text"
          }
        ],
        "emptyTag": 1,
        "altTag": "Act-On Software"
      },
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2019/11/Digital-Marketing-Master_thumbnail_1000w.png",
        "checkDisabled": false,
        "counts": {
          "warning": 0,
          "error": 0,
          "good": 3
        },
        "rules": [
          {
            "icon": "goodIcon",
            "description": "It's good that this image has an alt tag. Alt text helps search engines understand what the image is about. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "This image has an alt tag"
          },
          {
            "icon": "goodIcon",
            "description": "It's good that this image has alt text that contains the keyword. Alt text helps search engines understand what the image is about. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "The alt text for this image contains the keyword"
          },
          {
            "icon": "goodIcon",
            "description": "It's good that the keyword is used just once in the alt text for this image. You have only a few words (<55 characters and spaces) to communicate what the image is about. Using the keyword just once lets you maximize the rest of the space.",
            "title": "The keyword is used just once in the alt text for this image"
          }
        ],
        "emptyTag": 1,
        "altTag": "Digital Marketing Master"
      },
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2019/11/SOMA_thumbnail_600h.jpg",
        "checkDisabled": false,
        "counts": {
          "warning": 0,
          "error": 0,
          "good": 3
        },
        "rules": [
          {
            "icon": "goodIcon",
            "description": "It's good that this image has an alt tag. Alt text helps search engines understand what the image is about. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "This image has an alt tag"
          },
          {
            "icon": "goodIcon",
            "description": "It's good that this image has alt text that contains the keyword. Alt text helps search engines understand what the image is about. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "The alt text for this image contains the keyword"
          },
          {
            "icon": "goodIcon",
            "description": "It's good that the keyword is used just once in the alt text for this image. You have only a few words (<55 characters and spaces) to communicate what the image is about. Using the keyword just once lets you maximize the rest of the space.",
            "title": "The keyword is used just once in the alt text for this image"
          }
        ],
        "emptyTag": 1,
        "altTag": "The State of Marketing Automation 2019"
      },
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2019/12/graphic_tout_webinarCCPA_orange_100x600.png",
        "checkDisabled": false,
        "counts": {
          "warning": 1,
          "error": 0,
          "good": 0
        },
        "rules": [
          {
            "icon": "warningIcon",
            "description": "Alt tag text helps search engines understand what an image is about. This helps your page rank better for your keywords. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "The alt tag for this image is empty"
          }
        ],
        "emptyTag": 1,
        "altTag": ""
      },
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2019/08/Bisco-Industries_blue-300x95.png",
        "checkDisabled": false,
        "counts": {
          "warning": 1,
          "error": 0,
          "good": 1
        },
        "rules": [
          {
            "icon": "goodIcon",
            "description": "It's good that this image has an alt tag. Alt text helps search engines understand what the image is about. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "This image has an alt tag"
          },
          {
            "icon": "warningIcon",
            "description": "It's good to use your keyword in the alt text of your images when it makes sense. The alt text is a short "stand in" in the event that the image itself is not available, so you can skip including the keyword if it isn't the best way to describe the image. For images that play only a decorative role in the page, use an empty alt (i.e. alt="").",
            "title": "This image doesn't have the keyword in the alt text"
          }
        ],
        "emptyTag": 1,
        "altTag": "Bisco Industries"
      },
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2016/04/footer-awards.png",
        "checkDisabled": false,
        "counts": {
          "warning": 0,
          "error": 1,
          "good": 0
        },
        "rules": [
          {
            "icon": "errorIcon",
            "description": "Alt tag text helps search engines understand what an image is about. This helps your page rank better for your keywords. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "This image does not have an alt tag"
          }
        ],
        "emptyTag": 0
      },
      {
        "src": "https://mk0actonphoenix1inww.kinstacdn.com/app/uploads/2019/04/PDXWIT-Sponsor-2019.png",
        "checkDisabled": false,
        "counts": {
          "warning": 1,
          "error": 0,
          "good": 0
        },
        "rules": [
          {
            "icon": "warningIcon",
            "description": "Alt tag text helps search engines understand what an image is about. This helps your page rank better for your keywords. Well-written alt text will also support accessibility for visually impaired visitors.",
            "title": "The alt tag for this image is empty"
          }
        ],
        "emptyTag": 1,
        "altTag": ""
      }
    ],
    "counts": {
      "warning": 4,
      "error": 1,
      "good": 8
    }
  },
  "urlResults": {
    "score": 3,
    "counts": {
      "warning": 0,
      "error": 1,
      "good": 1
    },
    "rules": [
      {
        "icon": "goodIcon",
        "description": "The URL of this page is a good length. Research shows content with shorter URLs has a higher click-through-rate than content with long URLs.",
        "title": "The URL is shorter than 115 characters"
      },
      {
        "icon": "errorIcon",
        "description": "It is extremely important to use your keyword in the URL. This is the word (or phrase) you want searchers to find your page for. They are far more likely to click on your listing if they see the words in the URL.",
        "title": "The keyword isn't being used in the page URL"
      }
    ]
  },
  "seoId": "seo-0003",
  "fields": {
    "description": "Act-On marketing automation software helps you attract better prospects, nurture leads at scale, close opportunities faster, and prove ROI with analytics.",
    "selectedKeywords": [
      "kw_0001"
    ],
    "title": "Act-On — Exceptional Marketing Automation Software",
    "selectedKeywordsTerms": [
      "marketing"
    ],
    "url": "https://act-on.com"
  }
}

 

Code Examples

cURLPython

curl -X GET 'https://restapi.actonsoftware.com/api/1/seoreport?keyword=Marketing&url=https%3A%2F%2Fact-on.com' -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"

Coming Soon