thruuu Content Brief API – Detailed Content Block Data Object

The contentBlock is an array that contains all the elements from the brief template (e.g., Writer Directive, Article Summary, Outline). Each of these elements contains specific information.

{
  "eventType": "bulk-brief",
  "id": "670a9411a237576baf4a7135",
  "briefs": [
    {
      "id": "670a9426f5a0ccf086712534",
      "label": "brief example",
      "keyword": "brief example",
      "status": "Draft",
      "relatedSERP": "<SERP ID>",
      "contentBlock": [/* Array data here */],
      "creationDate": "2024-10-12T15:22:14.360Z",
      "modificationDate": "2024-10-12T15:22:14.360Z"
    }
  ]
}

Content Block

• Description: The contentBlock is an array that contains all the elements from the brief template.
• Type: Array of Objects

Block – Writer Directive

This block provides guidance to the writer, including search intent, target audience, and key information about the keyword.

Fields:

• position (Number)
  • Description: The order in which this block appears in the content brief.
• content (Object)
  • query (String): The keyword or query associated with the content.
  • note (String or null): Any additional notes for the writer (can be null if no notes are provided).
  • audience (String or null): The target audience for the content.
  • country (String): The country relevant to the content or audience.
  • lang (String): The language for the content.
  • intent (String – HTML): A detailed explanation of the search intent, customer journey, and what the audience is looking for.
  • region (String or null): The region for which the content is relevant.
• type (String)
  • Description: Specifies that this block is a writer directive.
  • Example: "writer_directive"

Block – Article Summary

This block summarizes the article, including the title, description, word count, and other details.

Fields:

• position (Number)
  • Description: The order in which this block appears in the content brief.
• content (Object)
  • title (String): The title of the article.
  • description (String): A brief description or summary of the article.
  • slug (String): The URL-friendly identifier for the article.
  • wordCount (Number): The total word count of the article.
    • Example: 2849
  • articleType (String or null): The type of article, such as blog post or guide.
  • tone (String or null): The tone of the article, such as formal, casual, etc.
• type (String)
  • Description: Specifies that this block is an article summary.
  • Example: "article_summary"

Block – Outline

This block provides a detailed outline of the content, with headings, paragraphs, and structured data.

Fields:

• position (Number)
  • Description: The order in which this block appears in the content brief.
• content (String – HTML)
  • Description: The full HTML structure of the content, including headings, paragraphs, and other elements.
• type (String)
  • Description: Specifies that this block is an outline.
  • Example: "outline"
• structuredData (Array of Objects)
  • Description: Contains the structured elements (e.g., headings, paragraphs) used in the content outline.
  • Subfields:
    • tag (String): The HTML tag used (e.g., "h1", "h2", "p").
    • text (String): The text within the tag.
    • type (String): The type of content, such as "heading" or "other".
    • url (String or null): Any associated URL (can be null if not applicable).
• Example:

[
  {
    "tag": "h1",
    "text": "Understanding Content Briefs for Effective Content Creation",
    "type": "other",
    "url": null
  },
  {
    "tag": "h2",
    "text": "What is a content brief?",
    "type": "heading",
    "url": null
  }
]

Block – Questions

This block contains questions and answers related to the content topic, including “People Also Ask” (PAA) questions and additional questions.

Fields:

• position (Number)
  • Description: The order in which this block appears in the content brief.
• structuredData (Object)
  • Description: Contains two sections—paa (People Also Ask) and questions—which hold questions and their related answers.
  • paa (Array of Objects):
    • Description: Contains “People Also Ask” questions and possible answers.
    • Subfields:
      • tag (String): The HTML tag associated with the element (e.g., "p").
      • text (String): The text of the question.
      • type (String): The type of content, typically "other".
      • answers (Array of Strings): List of answers associated with the question (this array could be empty if no answer is provided).
      • questions (Array of Objects):
        • Description: Contains additional questions related to the topic.
        • Subfields:
          • tag (String): The HTML tag associated with the question (e.g., "p").
          • text (String): The text of the question.
          • type (String): The type of content, typically "other".
• type (String)
  • Description: Defines the type of content block, indicating that it contains structured data related to questions.
  • Example: "questions"

Example Structure:

{
  "position": 3,
  "structuredData": {
    "paa": [
      {
        "tag": "p",
        "text": "What is in a content brief?",
        "type": "other",
        "answers": []
      },
      {
        "tag": "p",
        "text": "How to write a content brief template?",
        "type": "other",
        "answers": [
          "How to Create Content Briefs (with 6 Templates)"
        ]
      }
    ],
    "questions": [
      {
        "tag": "p",
        "text": "What Is a Content Brief",
        "type": "other"
      },
      {
        "tag": "p",
        "text": "How to write a content brief",
        "type": "other"
      }
    ]
  },
  "type": "questions"
}

Block – Topics

This block provides insights into the key topics or terms found in the analyzed content. It includes frequency information, page occurrences, and additional data to help identify the most relevant terms for the keyword or query.

Fields:

• position (Number)
  • Description: The order in which this block appears in the content brief.
  • Example: 4
• content (Array of Objects)
  • Description: Each object represents a topic or term identified in the content, along with its details.
  • Fields:
    • term (String): The keyword or topic identified in the content.
    • tf (Number): Term frequency, indicating how many times the term appears across various pages.
    • found (Number): The number of pages in which the term is found.
    • min (Number): The minimum number of times the term appears in a single page.
    • max (Number): The maximum number of times the term appears in a single page.
    • wordCount (Number): The number of words in the term or topic.
    • bestPage (Object):
      • Description: Details about the best-performing page for the term.
      • Subfields:
        • position (Number): The position of the page in the search results.
        • title (String): The title of the best-performing page.
          • Example: "How to Create Content Briefs [Step-by-Step Guide + Template]"
        • url (String): The URL of the best-performing page.
    • foundInPages (Array of Arrays):
      • Description: A list of pages in which the term was found, including the position and frequency.
      • Subfields:
        • Page Object (Object):
          • position (Number): The position of the page in the search results.
          • title (String): The title of the page.
          • url (String): The URL of the page.
          • Term Frequency (Number): How many times the term appeared in the respective page.
    • foundAverage (Number)
      • Description: The average number of times the term was found across pages.
    • foundAverageText (String)
      • Description: A textual representation of the average occurrences of the term across pages.
    • tfAverage (Number)
      • Description: The average term frequency across all pages where the term was found.
    • tIndex (Number)
      • Description: A relevance index based on the term frequency and occurrences across pages.
• type (String)
  • Description: The type of block, indicating that it is related to topics.
  • Example: "topics"

Example Structure:

{
  "position": 4,
  "content": [
    {
      "term": "title",
      "tf": 41,
      "found": 7,
      "min": 3,
      "max": 8,
      "wordCount": 1,
      "bestPage": {
        "position": 3,
        "title": "How to Create Content Briefs [Step-by-Step Guide + Template]",
        "url": "https://www.semrush.com/blog/content-brief/"
      },
      "foundInPages": [
        [
          {
            "position": 3,
            "title": "How to Create Content Briefs [Step-by-Step Guide + Template]",
            "url": "https://www.semrush.com/blog/content-brief/"
          },
          8
        ],
        [
          {
            "position": 4,
            "title": "What Is a Content Brief?",
            "url": "https://blog.marketmuse.com/what-is-a-content-brief/"
          },
          4
        ]
      ],
      "foundAverage": 0.7777777777777778,
      "foundAverageText": "7/9",
      "tfAverage": 5.857142857142857,
      "tIndex": 6.33611111111111
    }
  ],
  "type": "topics"
}

Block – SERP Insights

This block provides detailed SERP (Search Engine Results Page) insights, including word counts, page ranks, image counts, and update times for the top-ranking pages for a specific query.

Fields:

• position (Number):
  • Description: The order of this block in the content.
  • Example: 5
• type (String):
  • Description: Indicates the type of the block.
  • Example: "serp_insights"
• content (Object):
  • Description: Contains insights such as word count, page rank, images, and updates.

Content Object Structure:

• wordCount (Object):
  • average (Number): The average word count of the ranking pages.
  • long (Object): Details of the page with the longest word count.
    • wordCount (Number): 5746
    • position (Number): 6
    • serp_title (String): "How To Write an Effective Content Brief for Writers"
  • short (Object): Details of the page with the shortest word count.
    • wordCount (Number): 1374
    • position (Number): 10
    • serp_title (String): "How To Develop a Great Creative Brief and Get On-Target..."
• pageRank (Object):
  • average (Number): The average page rank of the pages.
  • best (Object): Details of the page with the best page rank.
    • page_rank_decimal (Number): 78
    • position (Number): 9
    • serp_title (String): "How Content Briefs Revolutionize Marketing Team..."
  • weakest (Object): Details of the page with the weakest page rank.
    • page_rank_decimal (Number): 42
    • position (Number): 7
    • serp_title (String): "What Is a Content Brief and How to Write It (+ Examples &..."
• images (Object):
  • average (Number): The average number of images in the top-ranking pages.
  • long (Object): Details of the page with the most images.
    • imgCount (Number): 34
    • position (Number): 3
    • serp_title (String): "How to Create Content Briefs [Step-by-Step Guide..."
  • short (Object): Details of the page with the fewest images.
    • imgCount (Number): 0
    • position (Number): 9
    • serp_title (String): "How Content Briefs Revolutionize Marketing Team..."
• update (Object):
  • average (Number): The average time since the last update of the pages.
  • old (Object): Details of the oldest page.
    • published_time (String): "2021-10-27T20:08:49+02:00"
    • position (Number): 1
    • serp_title (String): "What Is A Content Brief, And Why Is It Important? [Template]"
  • last (Object): Details of the most recently updated page.
    • modified_time (String): "2024-10-03T15:36:20+02:00"
    • position (Number): 4
    • serp_title (String): "What Is a Content Brief?"

Block – Top Titles

This block provides the top-ranking pages and their corresponding titles and headings.

Fields:

• position (Number): The order in which the block appears.
• displayed (Boolean): Whether the block is visible in the output.
• type (String): The type of block.
• content (Array of Objects): Each object represents a top title, along with its position and heading.
  • Fields:
    • position (Number): The SERP position of the page.
      • Example: 1
    • title (String): The title of the page.
      • Example: "What Is A Content Brief, And Why Is It Important? [Template]"
    • heading (String): The heading within the content of the page.
      • Example: "What Is A Content Brief (And Why Is It Important)?"

Block – Competitors

This block provides an analysis of competing pages based on several metrics such as page rank, word count, and image count.

Fields:

• position (Number): The order of the block.
• displayed (Boolean): Whether the block is visible.
• type (String): The type of block.
  • Example: "competitors"
• content (Array of Objects): Each object contains details of a competitor page, including its description, word count, and image count.
  • Fields:
    • position (Number): The position of the page in SERP.
      • Example: 1
    • title (String): The title of the competitor page.
    • description (String): A brief description of the page content.
    • url (String): The URL of the competitor page.
    • page_rank_decimal (Number): The page rank of the competitor page.
    • word_count (Number): The total word count of the page.

Block – Food for Thought

This block provides insights into the top competitors’ URLs and titles, showcasing what competitors are ranking for similar queries or topics. It’s useful for understanding how competitors are structuring their content.

Fields:

• position (Number): The order in which the block appears.
• content: List top 3 competitors.
• citedSources: List top 5 cited sources.
• type (String): The type of block.
• topCompetitors (Array of Objects): Lists the top competitors for the keyword/topic.
  • Fields:
    • title (String): The title of the competitor’s page.
    • url (String): The URL of the competitor’s page.
    • position (Number): The SERP position of the competitor.

Block – Links

This block contains relevant links, if any, for the content or page being analyzed.

Fields:

• position (Number): The order of this block in the content.
• type (String): The type of block.
• content (Object):
  • links (Array): An array of links

Block – Competitor Outlines

This block provides a breakdown of competitor content outlines, including titles, URLs, and the table of contents (TOC) structure with headings (H1, H2, H3).

Fields:

• position (Number): The order of this block in the content.
• type (String): The type of block.
• content (Object):
  • outline (Array of Objects): Each object contains details about a competitor’s content outline.
    • Fields:
      • title (String): The title of the competitor’s page.
      • url (String): The URL of the competitor’s page.
      • position (Number): The position of the competitor page in SERP.
      • toc (Array of Objects): The table of contents for the competitor’s content, outlining sections and subheadings.

Block – Free Text

This block provides space for free-form text, which can be used for additional notes or comments.

Fields:

• position (Number): The order of this block in the content.
• type (String): The type of block.
• content (Object):