---
title: "Get Analyze Layout Result"
method: GET
path: "/layout/analyzeResults/{resultId}"
---

# Get Analyze Layout Result

`GET /layout/analyzeResults/{resultId}`

Track the progress and obtain the result of the analyze layout operation

## Path parameters

- `resultId` string, uuid, required

## Response `200`

Success

- AnalyzeOperationResult — Status and result of the queued analyze operation.
  - `status` 'notStarted' | 'running' | 'succeeded' | 'failed', required — Status of the queued operation.
  - `createdDateTime` string, date-time, required — Date and time (UTC) when the analyze operation was submitted.
  - `lastUpdatedDateTime` string, date-time, required — Date and time (UTC) when the status was last updated.
  - `analyzeResult` AnalyzeResult — Analyze operation result.
    - `version` string, required — Version of schema used for this result.
    - `readResults` ReadResult[], required — Text extracted from the input.
      - `page` integer, required — The 1-based page number in the input document.
      - `angle` number, required — The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].
      - `width` number, required — The width of the image/PDF in pixels/inches, respectively.
      - `height` number, required — The height of the image/PDF in pixels/inches, respectively.
      - `unit` 'pixel' | 'inch', required — The unit used by the width, height and boundingBox properties. For images, the unit is "pixel". For PDF, the unit is "inch".
      - `language` 'en' | 'es' — Language code
      - `lines` TextLine[] — When includeTextDetails is set to true, a list of recognized text lines. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order.
        - `text` string, required — The text content of the line.
        - `boundingBox` number[], required — Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
        - `language` 'en' | 'es' — Language code
        - `words` TextWord[], required — List of words in the text line.
          - `text` string, required — The text content of the word.
          - `boundingBox` number[], required — Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
          - `confidence` number — Confidence value.
    - `pageResults` PageResult[] — Page-level information extracted from the input.
      - `page` integer, required — Page number.
      - `clusterId` integer — Cluster identifier.
      - `keyValuePairs` KeyValuePair[] — List of key-value pairs extracted from the page.
        - `label` string — A user defined label for the key/value pair entry.
        - `key` KeyValueElement, required — Information about the extracted key or value in a key-value pair.
          - `text` string, required — The text content of the key or value.
          - `boundingBox` number[] — Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
          - `elements` ElementReference[] — When includeTextDetails is set to true, a list of references to the text elements constituting this key or value.
        - `value` KeyValueElement, required — Information about the extracted key or value in a key-value pair.
          - `text` string, required — The text content of the key or value.
          - `boundingBox` number[] — Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
          - `elements` ElementReference[] — When includeTextDetails is set to true, a list of references to the text elements constituting this key or value.
        - `confidence` number, required — Confidence value.
      - `tables` DataTable[] — List of data tables extracted from the page.
        - `rows` integer, required — Number of rows.
        - `columns` integer, required — Number of columns.
        - `cells` DataTableCell[], required — List of cells contained in the table.
          - `rowIndex` integer, required — Row index of the cell.
          - `columnIndex` integer, required — Column index of the cell.
          - `rowSpan` integer — Number of rows spanned by this cell.
          - `columnSpan` integer — Number of columns spanned by this cell.
          - `text` string, required — Text content of the cell.
          - `boundingBox` number[], required — Quadrangle bounding box, with coordinates specified relative to the top-left of the original image. The eight numbers represent the four points, clockwise from the top-left corner relative to the text orientation. For image, the (x, y) coordinates are measured in pixels. For PDF, the (x, y) coordinates are measured in inches.
          - `confidence` number, required — Confidence value.
          - `elements` ElementReference[] — When includeTextDetails is set to true, a list of references to the text elements constituting this table cell.
          - `isHeader` boolean — Is the current cell a header cell?
          - `isFooter` boolean — Is the current cell a footer cell?
    - `documentResults` DocumentResult[] — Document-level information extracted from the input.
      - `docType` string, required — Document type.
      - `pageRange` integer[], required — First and last page number where the document is found.
      - `fields` object, required — Dictionary of named field values.
    - `errors` ErrorInformation[] — List of errors reported during the analyze operation.
      - `code` string, required
      - `message` string, required

## Other responses

- `default` — Response entity accompanying non-successful responses containing additional details about the error.

## Changes

- **2019-10-25** `925e0b5fe84f` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/azure/apis/form-recognizer-client/changes/layout/analyzeResults/:resultId/get.md)

---

[API](https://skmtc.dev/azure/apis/form-recognizer-client.md) · [All operations](https://skmtc.dev/azure/apis/form-recognizer-client/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/form-recognizer-client/revisions/f77e48809807/schema)