# Tóm tắt OnPage API

**API:** Data API

**Endpoint:** `GET /v1/beta/dataforseo/on_page/summary/{id}`

**Tags:** DataForSEO

Trạng thái và các chỉ số chính của một lượt crawl, theo `id`. Trả về `crawl_progress`, `crawl_status`, `crawl_gateway_address`, `crawl_stop_reason`, `domain_info` và `page_metrics`. Được bọc trong phong bì của DataForSEO: dữ liệu ở `tasks[0].result`, kết quả ở `tasks[0].status_code` - yêu cầu bị từ chối vẫn trả về HTTP 200. **Đây cũng là cách để biết một lượt crawl đã xong** - thăm dò cho tới khi `crawl_progress` là `finished` trước khi đọc bất kỳ endpoint nào khác ở đây, nếu không bạn sẽ đọc phải kết quả một phần trông như thật. 💰 Miễn phí ở phía upstream: truy vấn một lượt crawl đã hoàn tất không tốn phí, chỉ bản thân lượt crawl mới tốn phí.

### Tham chiếu giá

- Đo lường: Chi phí phản hồi được báo cáo.
- Ước tính tham chiếu cho mỗi yêu cầu: USD 0.012.
- Hệ số khách hàng tham chiếu: 1.0. Không áp dụng lại cho số tiền khách hàng đã quyết toán.

Chỉ là siêu dữ liệu tham chiếu, không phải báo giá cho tài khoản, mức giá được bảo đảm hay hạn mức chi tiêu. Tín dụng tài nguyên không phải tín dụng Felo. Khoản phí cuối cùng tuân theo bản ghi thanh toán của Felo.

## Related links

- [Task POST](<https://docs.dataforseo.com/v3/on_page/task_post/>)
- [phần Tổng quan](<https://docs.dataforseo.com/v3/on_page/overview>)
- [On Page API Force Stop](<https://docs.dataforseo.com/v3/on_page/force_stop>)
- [X.509](<https://en.wikipedia.org/wiki/X.509>)
- [bài viết trung tâm trợ giúp này](<https://dataforseo.com/help-center/how-is-onpage-score-of-a-domain-calculated>)
- [endpoint này](<https://docs.dataforseo.com/v3/on_page/non_indexable/?bash>)

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| `id` | path | yes | string | <em>mã định danh tác vụ</em><br><strong>trường bắt buộc</strong><br>bạn có thể lấy ID này trong phản hồi của endpoint Task POST<br>ví dụ:<br>“07131248-1535-0216-1000-17384017ad04” |

## Responses

### 200 — Thao tác thành công

Headers:
- `X-Request-Id` (string) — Mã định danh yêu cầu cần bao gồm khi liên hệ bộ phận hỗ trợ Felo.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryResponseInfo"
    }
  ]
}
```

### 400 — Không thể xử lý yêu cầu. Hãy kiểm tra các tham số yêu cầu.

### 401 — Cần có khóa API Felo hợp lệ.

### 402 — Không thể tiếp tục yêu cầu vì chưa đáp ứng yêu cầu thanh toán.

### 403 — Tài khoản không được phép thực hiện thao tác này.

### 429 — Đã đạt giới hạn yêu cầu hoặc giới hạn chi tiêu.

### 502 — Dịch vụ không thể hoàn tất yêu cầu.

### 503 — API hoặc dịch vụ thanh toán tạm thời không khả dụng.

### 504 — Dịch vụ đã hết thời gian chờ khi xử lý yêu cầu.

### default — Phản hồi lỗi; phản hồi chuyển tiếp từ thượng nguồn có thể dùng định dạng của nhà cung cấp

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "phiên bản hiện tại của API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "mã trạng thái chung; bạn có thể tìm danh sách đầy đủ các mã phản hồi tại đây"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "thông điệp thông tin chung; bạn có thể tìm danh sách đầy đủ các thông điệp thông tin chung tại đây"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "tổng thời gian thực thi, giây"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "tổng chi phí tác vụ, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "số lượng tác vụ trong mảng tasks",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "số lượng tác vụ trong mảng tasks được trả về kèm lỗi",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "mã định danh tác vụ; mã định danh tác vụ duy nhất trong hệ thống của chúng tôi ở định dạng UUID"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "mã trạng thái của tác vụ do DataForSEO tạo; có thể nằm trong khoảng sau: 10000-60000; bạn có thể tìm danh sách đầy đủ các mã phản hồi tại đây"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "thông điệp thông tin của tác vụ; bạn có thể tìm danh sách đầy đủ các thông điệp thông tin chung tại đây"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "thời gian thực thi, giây"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "tổng chi phí tác vụ, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "số phần tử trong mảng kết quả",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "Đường dẫn URL"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "chứa các tham số giống như bạn đã chỉ định trong yêu cầu POST"
    }
  }
}
```

### Response36Afe1097B20_CrawlStatusInfo

`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`

```json
{
  "type": "object",
  "properties": {
    "max_crawl_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "số trang tối đa được thu thập\ncho biết giới hạn max_crawl_pages bạn đã chỉ định khi tạo tác vụ",
      "format": "int64"
    },
    "pages_in_queue": {
      "type": [
        "integer",
        "null"
      ],
      "description": "số trang hiện đang trong hàng đợi thu thập",
      "format": "int64"
    },
    "pages_crawled": {
      "type": [
        "integer",
        "null"
      ],
      "description": "số trang đã thu thập",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_DomainInfo

`#/components/schemas/Response36Afe1097B20_DomainInfo`

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>tên miền</em>"
    },
    "cms": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>hệ quản trị nội dung</em><br>hệ quản trị nội dung được xác định trên website<br>nội dung của thẻ meta <code>generator</code><br>dữ liệu được lấy từ trang ngẫu nhiên đầu tiên trả về mã phản hồi 200<br>nếu trình thu thập không xác định được cms, giá trị sẽ là <code>null</code>"
    },
    "ip": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>địa chỉ ip của tên miền</em>"
    },
    "server": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>máy chủ website</em><br>phiên bản máy chủ được phát hiện trên website<br>nội dung của header <code class=\"prettyprint\">server</code><br>thông tin được lấy từ trang đầu tiên có mã phản hồi 200"
    },
    "crawl_start": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>thời điểm quá trình thu thập bắt đầu</em><br>ngày và giờ khi website được gửi đi thu thập<br>ở định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”<br>ví dụ:<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "crawl_end": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>thời điểm quá trình thu thập kết thúc</em><br>ngày và giờ khi quá trình thu thập hoàn tất<br>ở định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”<br>ví dụ:<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code><br><strong>Lưu ý:</strong> chỉ mang tính tham khảo nếu <code>\"crawl_progress\"</code> là <code>\"finished\"</code><br>nếu <code>\"crawl_progress\"</code> là <code>in_progress</code>, giá trị sẽ là <code>null</code>"
    },
    "extended_crawl_status": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>trạng thái và lỗi thu thập</em><br>cho biết lý do website không được thu thập;<br>có thể nhận các giá trị sau:<br><code>no_errors</code> - không phát hiện lỗi thu thập;<br><code>site_unreachable</code> - trình thu thập của chúng tôi không thể truy cập website và do đó không thể lấy mã trạng thái;<br><code>invalid_page_status_code</code> - mã trạng thái của trang được thu thập đầu tiên &gt;= 400;<br><code>forbidden_meta_tag</code> - trang được thu thập đầu tiên chứa thẻ &lt;meta robots=\"noindex\"&gt;;<br><code>forbidden_robots</code> - robots.txt cấm thu thập trang;<br><code>forbidden_http_header</code> - header HTTP của trang chứa \"X-Robots-Tag: noindex\" ;<br><code>too_many_redirects</code> - trang được thu thập đầu tiên có hơn 10 lần chuyển hướng;<br><code>unknown</code> - không rõ lý do"
    },
    "ssl_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_SslInfo"
        }
      ],
      "description": "<em>thông tin chứng chỉ ssl</em><br>thông tin về giao thức Secure Sockets Layer được phát hiện trên website"
    },
    "checks": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "boolean",
          "null"
        ]
      },
      "description": "<em>kiểm tra website</em><br>các kiểm tra trên trang khác liên quan đến website"
    },
    "total_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>tổng số trang đã thu thập</em><br>tổng số trang đã được thu thập",
      "format": "int64"
    },
    "total_uncrawlable_resources": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>tổng số tài nguyên không thể thu thập</em><br>tổng số tài nguyên không thể thu thập;<br>tài nguyên được coi là không thể thu thập khi loại nội dung thực tế của tài nguyên không khớp với loại nội dung mà trình thu thập mong đợi",
      "format": "int64"
    },
    "page_not_found_status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>mã trạng thái do trang không tồn tại trả về</em><br>trong hầu hết trường hợp, nên để máy chủ trả về mã phản hồi 404"
    },
    "canonicalization_status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>mã trạng thái do trang đã chuẩn hóa trả về</em><br>việc kiểm tra hành vi máy chủ khi trình thu thập của chúng tôi truy cập website qua IP;<br>trong hầu hết trường hợp, nên để các trang đã chuẩn hóa phản hồi bằng mã trạng thái <code>301</code> hoặc <code>302</code>"
    },
    "directory_browsing_status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>mã trạng thái do thư mục trả về</em><br>mã trạng thái do một trang thư mục trên website mục tiêu trả về<br>trong hầu hết trường hợp, nên để các thư mục phản hồi bằng mã trạng thái <code>403</code> hoặc <code>401</code>"
    },
    "www_redirect_status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>mã trạng thái chuyển hướng</em><br>mã trạng thái của chuyển hướng www sang non-www<br>trong hầu hết trường hợp, nên để chuyển hướng trả về mã trạng thái <code>301</code>"
    },
    "main_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>tên miền gốc</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageSummaryResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageSummaryResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryTaskInfo"
              }
            ]
          },
          "description": "<em>mảng tác vụ</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageSummaryResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageSummaryResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>trạng thái của phiên crawl</em><br>giá trị khả dụng: <code>in_progress</code>, <code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>chi tiết của phiên crawl</em>"
    },
    "crawl_gateway_address": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>địa chỉ IP của trình thu thập</em><br>hiển thị địa chỉ IP mà trình thu thập dùng để khởi tạo phiên crawl hiện tại<br>bạn có thể tìm danh sách đầy đủ các IP mà trình thu thập của chúng tôi sử dụng trong phần Tổng quan"
    },
    "crawl_stop_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>lý do quá trình crawl dừng lại</em><br>thông tin về lý do quá trình crawl dừng lại;<br>giá trị khả dụng:<br><code>limit_exceeded</code> - đã vượt giới hạn đặt trong <code>max_crawl_pages</code>;<br><code>empty_queue</code> - tất cả URL trong hàng đợi đã được crawl;<br><code>force_stopped</code> - quá trình crawl bị dừng bằng chức năng On Page API Force Stop;<br><code>unexpected_exception</code> - gặp lỗi nội bộ khi crawl <code>target</code>, hãy liên hệ bộ phận hỗ trợ để biết thêm thông tin"
    },
    "domain_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_DomainInfo"
        }
      ],
      "description": "<em>thông tin toàn miền</em><br>thông tin on-page về tên miền mục tiêu và quá trình crawl"
    },
    "page_metrics": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_PageMetrics"
        }
      ],
      "description": "<em>thông tin riêng của từng trang</em><br>thông tin chỉ số về các trang của trang web mục tiêu"
    }
  }
}
```

### Response36Afe1097B20_OnPageSummaryTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageSummaryTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPageSummaryResultInfo"
              }
            ]
          },
          "description": "<em>mảng kết quả</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_PageMetrics

`#/components/schemas/Response36Afe1097B20_PageMetrics`

```json
{
  "type": "object",
  "properties": {
    "links_external": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số liên kết ngoài</em><br>số liên kết trỏ tới các trang web khác"
    },
    "links_internal": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số liên kết nội bộ</em><br>số liên kết trỏ tới các trang khác trong trang web mục tiêu"
    },
    "duplicate_title": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số trang có tiêu đề trùng lặp</em>"
    },
    "duplicate_description": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số trang có mô tả trùng lặp</em>"
    },
    "duplicate_content": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số trang có nội dung trùng lặp</em>"
    },
    "broken_links": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số liên kết bị hỏng</em><br>số liên kết bị hỏng trên tất cả các trang đã crawl của một trang web mục tiêu"
    },
    "broken_resources": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số tài nguyên bị hỏng</em><br>số hình ảnh và tài nguyên khác có liên kết bị hỏng"
    },
    "links_relation_conflict": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số liên kết có trên trang web mục tiêu có thể bị xung đột</em><br>ví dụ: nếu <code>\"links_relation_conflict\": 2</code>, trang web mục tiêu đang tham chiếu cùng một nguồn bằng ít nhất một liên kết nội bộ có thuộc tính <code>rel=\"nofollow\"</code> <strong>và</strong> ít nhất một liên kết dofollow"
    },
    "redirect_loop": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số chuỗi chuyển hướng bắt đầu và kết thúc tại cùng một URL</em><br>số chuỗi chuyển hướng trong đó URL đích chuyển hướng ngược lại URL gốc"
    },
    "onpage_score": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>cho biết mức độ tối ưu của trang web theo thang điểm 100</em><br>trường này cho biết mức độ tối ưu của trang web dựa trên các vấn đề on-page nghiêm trọng và cảnh báo được phát hiện;<br><code>100</code> là điểm cao nhất có thể, nghĩa là trang web không có vấn đề on-page nghiêm trọng và cảnh báo quan trọng nào;<br><strong>lưu ý</strong> rằng giá trị này phụ thuộc vào số trang đã crawl;<br>tìm hiểu thêm về cách tính chỉ số này trong bài viết trung tâm trợ giúp này"
    },
    "non_indexable": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>số trang không thể lập chỉ mục</em><br>số trang bị Google và các công cụ tìm kiếm khác chặn lập chỉ mục bằng robots.txt, header HTTP hoặc cài đặt thẻ meta;<br>bạn có thể nhận danh sách URL không thể lập chỉ mục bằng endpoint này"
    },
    "checks": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>kiểm tra on-page riêng cho từng trang</em>"
    }
  }
}
```

### Response36Afe1097B20_SslInfo

`#/components/schemas/Response36Afe1097B20_SslInfo`

```json
{
  "type": "object",
  "properties": {
    "valid_certificate": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>tính hợp lệ của chứng chỉ ssl</em><br>cho biết chứng chỉ ssl được phát hiện trên website có hợp lệ hay không, tức là không hết hạn, không bị tạm ngưng, không bị thu hồi và không ở trạng thái không hợp lệ"
    },
    "certificate_issuer": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>nhà cấp chứng chỉ ssl</em><br>thực thể đã phát hành chứng chỉ ssl được phát hiện"
    },
    "certificate_subject": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>chủ thể chứng chỉ ssl</em><br>thực thể được liên kết với khóa công khai"
    },
    "certificate_version": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>phiên bản chứng chỉ ssl</em><br>cho biết phiên bản X.509 được chứng chỉ ssl sử dụng"
    },
    "certificate_hash": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>mã băm chứng chỉ ssl</em><br>phiên bản của hàm băm chứng chỉ ssl"
    },
    "certificate_expiration_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ngày hết hạn của chứng chỉ ssl</em><br>ngày và giờ chứng chỉ ssl hết hạn<br>theo định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”<br>ví dụ:<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    }
  }
}
```
