v0.2.0-beta

OpenAPI 3.1.0

Tóm tắt OnPage API

Felo API Support

MIT

Máy chủ

https://openapi.felo.ai

Thư viện client

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Thao tác

get/v1/beta/dataforseo/on_page/summary/{id}

Tóm tắt OnPage API

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.

Tham số đường dẫn

id
Kiểu: string
bắt buộc

mã định danh tác vụ
trường bắt buộc
bạn có thể lấy ID này trong phản hồi của endpoint Task POST
ví dụ:
“07131248-1535-0216-1000-17384017ad04”

Phản hồi

200
Kiểu: object | null · Response36Afe1097B20_OnPageSummaryResponseInfo
cost
Kiểu: number | null Định dạng: double

tổng chi phí tác vụ, USD

status_code
Kiểu: integer | null

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
Kiểu: string | null

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

tasks
Kiểu: array (object | null)[] | null

mảng tác vụ

Kiểu: object | null · Response36Afe1097B20_OnPageSummaryTaskInfo
cost
Kiểu: number | null Định dạng: double

tổng chi phí tác vụ, USD

data
Kiểu: object | null

chứa các tham số giống như bạn đã chỉ định trong yêu cầu POST

propertyName
Kiểu: object | null
id
Kiểu: string | null

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

path
Kiểu: array (string | null)[] | null

Đường dẫn URL

result
Kiểu: array (object | null)[] | null

mảng kết quả

crawl_gateway_address
Kiểu: string | null

địa chỉ IP của trình thu thập
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
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_progress
Kiểu: string | null

trạng thái của phiên crawl
giá trị khả dụng: in_progress, finished

crawl_status
Kiểu: object | null · Response36Afe1097B20_CrawlStatusInfo

chi tiết của phiên crawl

max_crawl_pages
Kiểu: integer | null Định dạng: int64

số trang tối đa được thu thập cho biết giới hạn max_crawl_pages bạn đã chỉ định khi tạo tác vụ

pages_crawled
Kiểu: integer | null Định dạng: int64

số trang đã thu thập

pages_in_queue
Kiểu: integer | null Định dạng: int64

số trang hiện đang trong hàng đợi thu thập

crawl_stop_reason
Kiểu: string | null

lý do quá trình crawl dừng lại
thông tin về lý do quá trình crawl dừng lại;
giá trị khả dụng:
limit_exceeded - đã vượt giới hạn đặt trong max_crawl_pages;
empty_queue - tất cả URL trong hàng đợi đã được crawl;
force_stopped - quá trình crawl bị dừng bằng chức năng On Page API Force Stop;
unexpected_exception - gặp lỗi nội bộ khi crawl target, hãy liên hệ bộ phận hỗ trợ để biết thêm thông tin

domain_info
Kiểu: object | null · Response36Afe1097B20_DomainInfo

thông tin toàn miền
thông tin on-page về tên miền mục tiêu và quá trình crawl

canonicalization_status_code
Kiểu: integer | null

mã trạng thái do trang đã chuẩn hóa trả về
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;
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 301 hoặc 302

checks
Kiểu: object | null

kiểm tra website
các kiểm tra trên trang khác liên quan đến website

propertyName
Kiểu: boolean | null
cms
Kiểu: string | null

hệ quản trị nội dung
hệ quản trị nội dung được xác định trên website
nội dung của thẻ meta generator
dữ liệu được lấy từ trang ngẫu nhiên đầu tiên trả về mã phản hồi 200
nếu trình thu thập không xác định được cms, giá trị sẽ là null

crawl_end
Kiểu: string | null

thời điểm quá trình thu thập kết thúc
ngày và giờ khi quá trình thu thập hoàn tất
ở định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”
ví dụ:
2019-11-15 12:57:46 +00:00
Lưu ý: chỉ mang tính tham khảo nếu "crawl_progress" là "finished"
nếu "crawl_progress" là in_progress, giá trị sẽ là null

crawl_start
Kiểu: string | null

thời điểm quá trình thu thập bắt đầu
ngày và giờ khi website được gửi đi thu thập
ở định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”
ví dụ:
2019-11-15 12:57:46 +00:00

directory_browsing_status_code
Kiểu: integer | null

mã trạng thái do thư mục trả về
mã trạng thái do một trang thư mục trên website mục tiêu trả về
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 403 hoặc 401

extended_crawl_status
Kiểu: string | null

trạng thái và lỗi thu thập
cho biết lý do website không được thu thập;
có thể nhận các giá trị sau:
no_errors - không phát hiện lỗi thu thập;
site_unreachable - 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;
invalid_page_status_code - mã trạng thái của trang được thu thập đầu tiên >= 400;
forbidden_meta_tag - trang được thu thập đầu tiên chứa thẻ <meta robots="noindex">;
forbidden_robots - robots.txt cấm thu thập trang;
forbidden_http_header - header HTTP của trang chứa "X-Robots-Tag: noindex" ;
too_many_redirects - trang được thu thập đầu tiên có hơn 10 lần chuyển hướng;
unknown - không rõ lý do

ip
Kiểu: string | null

địa chỉ ip của tên miền

main_domain
Kiểu: string | null

tên miền gốc

name
Kiểu: string | null

tên miền

page_not_found_status_code
Kiểu: integer | null

mã trạng thái do trang không tồn tại trả về
trong hầu hết trường hợp, nên để máy chủ trả về mã phản hồi 404

server
Kiểu: string | null

máy chủ website
phiên bản máy chủ được phát hiện trên website
nội dung của header server
thông tin được lấy từ trang đầu tiên có mã phản hồi 200

ssl_info
Kiểu: object | null · Response36Afe1097B20_SslInfo

thông tin chứng chỉ ssl
thông tin về giao thức Secure Sockets Layer được phát hiện trên website

certificate_expiration_date
Kiểu: string | null

ngày hết hạn của chứng chỉ ssl
ngày và giờ chứng chỉ ssl hết hạn
theo định dạng UTC: “yyyy-mm-dd hh-mm-ss +00:00”
ví dụ:
2019-11-15 12:57:46 +00:00

certificate_hash
Kiểu: string | null

mã băm chứng chỉ ssl
phiên bản của hàm băm chứng chỉ ssl

certificate_issuer
Kiểu: string | null

nhà cấp chứng chỉ ssl
thực thể đã phát hành chứng chỉ ssl được phát hiện

certificate_subject
Kiểu: string | null

chủ thể chứng chỉ ssl
thực thể được liên kết với khóa công khai

certificate_version
Kiểu: integer | null

phiên bản chứng chỉ ssl
cho biết phiên bản X.509 được chứng chỉ ssl sử dụng

valid_certificate
Kiểu: boolean | null

tính hợp lệ của chứng chỉ ssl
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ệ

total_pages
Kiểu: integer | null Định dạng: int64

tổng số trang đã thu thập
tổng số trang đã được thu thập

total_uncrawlable_resources
Kiểu: integer | null Định dạng: int64

tổng số tài nguyên không thể thu thập
tổng số tài nguyên không thể thu thập;
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

www_redirect_status_code
Kiểu: integer | null

mã trạng thái chuyển hướng
mã trạng thái của chuyển hướng www sang non-www
trong hầu hết trường hợp, nên để chuyển hướng trả về mã trạng thái 301

page_metrics
Kiểu: object | null · Response36Afe1097B20_PageMetrics

thông tin riêng của từng trang
thông tin chỉ số về các trang của trang web mục tiêu

broken_links
Kiểu: integer | null

số liên kết bị hỏng
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
Kiểu: integer | null

số tài nguyên bị hỏng
số hình ảnh và tài nguyên khác có liên kết bị hỏng

checks
Kiểu: object | null

kiểm tra on-page riêng cho từng trang

propertyName
Kiểu: integer | null Định dạng: int64

Signed 64-bit integers (long type).

duplicate_content
Kiểu: integer | null

số trang có nội dung trùng lặp

duplicate_description
Kiểu: integer | null

số trang có mô tả trùng lặp

duplicate_title
Kiểu: integer | null

số trang có tiêu đề trùng lặp

links_external
Kiểu: integer | null

số liên kết ngoài
số liên kết trỏ tới các trang web khác

links_internal
Kiểu: integer | null

số liên kết nội bộ
số liên kết trỏ tới các trang khác trong trang web mục tiêu

links_relation_conflict
Kiểu: integer | null

số liên kết có trên trang web mục tiêu có thể bị xung đột
ví dụ: nếu "links_relation_conflict": 2, 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 rel="nofollow" và ít nhất một liên kết dofollow

non_indexable
Kiểu: integer | null

số trang không thể lập chỉ mục
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;
bạn có thể nhận danh sách URL không thể lập chỉ mục bằng endpoint này

onpage_score
Kiểu: number | null

cho biết mức độ tối ưu của trang web theo thang điểm 100
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;
100 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;
lưu ý rằng giá trị này phụ thuộc vào số trang đã crawl;
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

redirect_loop
Kiểu: integer | null

số chuỗi chuyển hướng bắt đầu và kết thúc tại cùng một URL
số chuỗi chuyển hướng trong đó URL đích chuyển hướng ngược lại URL gốc

result_count
Kiểu: integer | null Định dạng: int64

số phần tử trong mảng kết quả

status_code
Kiểu: integer | null

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
Kiểu: string | null

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
Kiểu: string | null

thời gian thực thi, giây

tasks_count
Kiểu: integer | null Định dạng: int64

số lượng tác vụ trong mảng tasks

tasks_error
Kiểu: integer | null Định dạng: int64

số lượng tác vụ trong mảng tasks được trả về kèm lỗi

time
Kiểu: string | null

tổng thời gian thực thi, giây

version
Kiểu: string | null

phiên bản hiện tại của API
application/json
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

get/v1/beta/dataforseo/on_page/summary/{id}

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/summary/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Hiện schema

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "crawl_progress": null,
          "crawl_status": {
            "max_crawl_pages": null,
            "pages_in_queue": null,
            "pages_crawled": null
          },
          "crawl_gateway_address": null,
          "crawl_stop_reason": null,
          "domain_info": {
            "name": null,
            "cms": null,
            "ip": null,
            "server": null,
            "crawl_start": null,
            "crawl_end": null,
            "extended_crawl_status": null,
            "ssl_info": "[Max Depth Exceeded]",
            "checks": null,
            "total_pages": null,
            "total_uncrawlable_resources": null,
            "page_not_found_status_code": null,
            "canonicalization_status_code": null,
            "directory_browsing_status_code": null,
            "www_redirect_status_code": null,
            "main_domain": null
          },
          "page_metrics": {
            "links_external": null,
            "links_internal": null,
            "duplicate_title": null,
            "duplicate_description": null,
            "duplicate_content": null,
            "broken_links": null,
            "broken_resources": null,
            "links_relation_conflict": null,
            "redirect_loop": null,
            "onpage_score": null,
            "non_indexable": null,
            "checks": null
          }
        }
      ]
    }
  ]
}

Thao tác thành công

Tóm tắt OnPage API

Xác thựcRequired

DataForSEO

Tóm tắt OnPage API

Tham chiếu giá