Skip to content

GET /api/v1/report/structure/

Returns the page structure (meta tags, headings, content metrics) for your page and all competitors.

Request

http
GET /api/v1/report/structure/550e8400-e29b-41d4-a716-446655440000
Authorization: Bearer YOUR_KEY

Response

An array of objects — the first element is always your page, followed by competitors.

json
[
  {
    "url": "https://example.com/product",
    "meta_tags": {
      "title": "Buy Mattress — Example Store",
      "title_length": 28,
      "description": "Orthopedic mattresses with free delivery.",
      "description_length": 41
    },
    "content": {
      "h1_heading": "Orthopedic Mattresses",
      "heading_structure_raw": "H1: Orthopedic Mattresses; H2: Features; H2: Delivery; H3: Terms"
    },
    "metrics": {
      "char_count_no_spaces": 4821,
      "uniqueness_percentage": 91.3
    }
  },
  {
    "url": "https://comp1.com/mattress",
    "meta_tags": { ... },
    "content": { ... },
    "metrics": { ... }
  }
]

Page Object Fields

FieldTypeDescription
urlstringPage URL
meta_tags.titlestring<title> tag content
meta_tags.title_lengthintegerTitle length in characters
meta_tags.descriptionstringMeta description
meta_tags.description_lengthintegerMeta description length
content.h1_headingstringText of the first <h1>
content.heading_structure_rawstringAll H1–H6 headings separated by ;
metrics.char_count_no_spacesintegerCharacter count (no spaces)
metrics.uniqueness_percentagefloatText uniqueness (%)

Status Codes

CodeMeaning
200Success
404Task not found or structure not ready yet
401Unauthorized

TIP

Page structure is included automatically in the Python SDK (result["page_structure"]). This endpoint is needed when using the REST API directly.