open-ai-actions/dataforseo_on_page_openapi.json at master · dataforseo/open-ai-actions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
  "openapi": "3.1.0",
  "info": {
    "title": "DataForSEO On Page API",
    "description": "Access to DataForSEO On Page tools for SEO research and analysis",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://api.dataforseo.com"
    }
  ],
  "paths": {
    "/v3/on_page/content_parsing/live.ai": {
      "post": {
        "description": "This endpoint allows parsing the content on any page you specify and will return the structured content of the target page, including link URLs, anchors, headings, and textual content.",
        "operationId": "on_page_content_parsing",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "URL of the page to parse"
                  },
                  "enable_javascript": {
                    "type": "boolean",
                    "description": "Enable JavaScript rendering"
                  },
                  "custom_user_agent": {
                    "type": "string",
                    "description": "Custom User-Agent header"
                  },
                  "accept_language": {
                    "type": "string",
                    "description": "Accept-Language header value"
                  }
                },
                "required": [
                  "url"
                ]
              }
            }
          }
        }
      }
    },
    "/v3/on_page/instant_pages.ai": {
      "post": {
        "description": "Using this function you will get page-specific data with detailed information on how well a particular page is optimized for organic search",
        "operationId": "on_page_instant_pages",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "URL to analyze"
                  },
                  "enable_javascript": {
                    "type": "boolean",
                    "description": "Enable JavaScript rendering"
                  },
                  "custom_js": {
                    "type": "string",
                    "description": "Custom JavaScript code to execute"
                  },
                  "custom_user_agent": {
                    "type": "string",
                    "description": "Custom User-Agent header"
                  },
                  "accept_language": {
                    "type": "string",
                    "description": "language header for accessing the website\n        all locale formats are supported (xx, xx-XX, xxx-XX, etc.)\n        Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the \"type\":\"broken in the response array"
                  }
                },
                "required": [
                  "url"
                ]
              }
            }
          }
        }
      }
    },
    "/v3/on_page/lighthouse/live/json.ai": {
      "post": {
        "description": "The OnPage Lighthouse API is based on Google’s open-source Lighthouse project for measuring the quality of web pages and web apps.",
        "operationId": "on_page_lighthouse",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "URL of the page to parse"
                  },
                  "enable_javascript": {
                    "type": "boolean",
                    "description": "Enable JavaScript rendering"
                  },
                  "custom_user_agent": {
                    "type": "string",
                    "description": "Custom User-Agent header"
                  },
                  "accept_language": {
                    "type": "string",
                    "description": "Accept-Language header value"
                  },
                  "full_data": {
                    "type": "boolean",
                    "description": "Return the complete API response instead of a reduced version"
                  }
                },
                "required": [
                  "url"
                ]
              }
            }
          }
        }
      }
    }
  }
}