airbyte-source-google-search-console 1.3.7__py3-none-any.whl → 1.4.2__py3-none-any.whl

Sign up to get free protection for your applications and to get access to all the features.
Files changed (18) hide show
  1. {airbyte_source_google_search_console-1.3.7.dist-info → airbyte_source_google_search_console-1.4.2.dist-info}/METADATA +2 -2
  2. {airbyte_source_google_search_console-1.3.7.dist-info → airbyte_source_google_search_console-1.4.2.dist-info}/RECORD +18 -18
  3. source_google_search_console/schemas/search_analytics_all_fields.json +11 -0
  4. source_google_search_console/schemas/search_analytics_by_country.json +8 -0
  5. source_google_search_console/schemas/search_analytics_by_date.json +7 -0
  6. source_google_search_console/schemas/search_analytics_by_device.json +8 -0
  7. source_google_search_console/schemas/search_analytics_by_page.json +8 -0
  8. source_google_search_console/schemas/search_analytics_by_query.json +8 -0
  9. source_google_search_console/schemas/search_analytics_keyword_page_report.json +11 -0
  10. source_google_search_console/schemas/search_analytics_keyword_site_report_by_page.json +10 -0
  11. source_google_search_console/schemas/search_analytics_keyword_site_report_by_site.json +10 -0
  12. source_google_search_console/schemas/search_analytics_page_report.json +10 -0
  13. source_google_search_console/schemas/search_analytics_site_report_by_page.json +9 -0
  14. source_google_search_console/schemas/search_analytics_site_report_by_site.json +9 -0
  15. source_google_search_console/schemas/sitemaps.json +12 -0
  16. source_google_search_console/schemas/sites.json +2 -0
  17. {airbyte_source_google_search_console-1.3.7.dist-info → airbyte_source_google_search_console-1.4.2.dist-info}/WHEEL +0 -0
  18. {airbyte_source_google_search_console-1.3.7.dist-info → airbyte_source_google_search_console-1.4.2.dist-info}/entry_points.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: airbyte-source-google-search-console
3
- Version: 1.3.7
3
+ Version: 1.4.2
4
4
  Summary: Source implementation for Google Search Console.
5
5
  Home-page: https://airbyte.com
6
6
  License: Elv2
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
12
12
  Classifier: Programming Language :: Python :: 3.9
13
13
  Classifier: Programming Language :: Python :: 3.10
14
14
  Classifier: Programming Language :: Python :: 3.11
15
- Requires-Dist: airbyte-cdk (==0.52.4)
15
+ Requires-Dist: airbyte-cdk (==0.80.0)
16
16
  Requires-Dist: google-api-python-client (==2.105.0)
17
17
  Requires-Dist: google-auth (==2.23.3)
18
18
  Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/google-search-console
@@ -2,25 +2,25 @@ source_google_search_console/__init__.py,sha256=HQCPu-CK7XmVDtP9rmTdB2XyraVCc6pv
2
2
  source_google_search_console/config_migrations.py,sha256=IdiV5EHazAA4hMFm8S1Dqhb-8DMERriEvaYVMsPzs4U,4134
3
3
  source_google_search_console/exceptions.py,sha256=iD3jYC4WxVCEKGsqQ7Vaj1tbjhJZ4S5mnSDnwFJdsIQ,1097
4
4
  source_google_search_console/run.py,sha256=q6O2iXoxtrdgtodCaanqTO2eKzUvXF2iDCfmCxaPE24,462
5
- source_google_search_console/schemas/search_analytics_all_fields.json,sha256=tyqmMuF1mTU94EE0nM0RMJ40Qqpa6AhTbGERdNC075g,804
6
- source_google_search_console/schemas/search_analytics_by_country.json,sha256=JdlBPe8xCiqLOLvZqrbIogQyjcXqKdl6l9Nde9Hd9go,639
7
- source_google_search_console/schemas/search_analytics_by_date.json,sha256=_LhzCePVWJ0fe782Ktnm2eNyPxAHbSoO1AS-FtvP4Yg,582
8
- source_google_search_console/schemas/search_analytics_by_device.json,sha256=5C6Pc0MVJBSLJIw9pJGPPNoKp4dSYfYTXCDIh37-2NQ,638
9
- source_google_search_console/schemas/search_analytics_by_page.json,sha256=EIY-6HQZFKqP8OehJmLS8g6kgUyuXi4OP6JWYgzlv3Q,636
10
- source_google_search_console/schemas/search_analytics_by_query.json,sha256=v8X43HtVCq-G-En9lU20jCxsg7FZktlU3KxUCjR8Nc8,637
11
- source_google_search_console/schemas/search_analytics_keyword_page_report.json,sha256=EMoww91e5Tv2MUBOxU_faLbn9sNNeeo3L349rH6jvd8,837
12
- source_google_search_console/schemas/search_analytics_keyword_site_report_by_page.json,sha256=0Cu-r0KUQjIm2paiIAYIpJyirjAbbnsjO3b_mePaGIM,783
13
- source_google_search_console/schemas/search_analytics_keyword_site_report_by_site.json,sha256=0Cu-r0KUQjIm2paiIAYIpJyirjAbbnsjO3b_mePaGIM,783
14
- source_google_search_console/schemas/search_analytics_page_report.json,sha256=FR-Ii7BMre3DuwMw3vMKjVtSAOe0iy3tkusWrtBGV7k,782
15
- source_google_search_console/schemas/search_analytics_site_report_by_page.json,sha256=bg3eHS06Z8YTGD6v0bsyHNRmh5v9lvSWl_TlbNuEJZ4,728
16
- source_google_search_console/schemas/search_analytics_site_report_by_site.json,sha256=bg3eHS06Z8YTGD6v0bsyHNRmh5v9lvSWl_TlbNuEJZ4,728
17
- source_google_search_console/schemas/sitemaps.json,sha256=-Wf7ilaD_c7pKVKl8SF4lmBgalnRwW4V_aSOCEXgWbg,990
18
- source_google_search_console/schemas/sites.json,sha256=9H1tBakHEwNGLRmLzcTlGwOCo59HedgzUc-iccSVxT4,223
5
+ source_google_search_console/schemas/search_analytics_all_fields.json,sha256=iQxRh_c_yz3uGofqpo1KX571TMmzYjKScb0PtI6SN_Q,1729
6
+ source_google_search_console/schemas/search_analytics_by_country.json,sha256=xvUVjGRy63dsc7c0O-Kg7DUzybRpD-r_-VYhPmDBw_o,1491
7
+ source_google_search_console/schemas/search_analytics_by_date.json,sha256=meCbWDayc1y0q-Lu-CAdjQVnsM8xZBX3BdF129UC1P8,1388
8
+ source_google_search_console/schemas/search_analytics_by_device.json,sha256=VtoFjmmv9rx-uhSFaRn0wm4LeSxRIaexrxg2Spvbneo,1525
9
+ source_google_search_console/schemas/search_analytics_by_page.json,sha256=KyUojZc4Lv3hPswxIJzUL5QDNsbvSugGjl_uHGF7Am4,1473
10
+ source_google_search_console/schemas/search_analytics_by_query.json,sha256=mYc1Fu1A5TWLZCApZSjjfs_urW5BRUCPQI3rw3yQjt4,1439
11
+ source_google_search_console/schemas/search_analytics_keyword_page_report.json,sha256=hCQZbpW9UNiCOrnUMkj4oQdzY0k8Hqoh1XkuKHvyvZw,1681
12
+ source_google_search_console/schemas/search_analytics_keyword_site_report_by_page.json,sha256=lFpbShmTQhFyySc_JCdIOqMP9RfOIA15fpQN9xNXtTI,1626
13
+ source_google_search_console/schemas/search_analytics_keyword_site_report_by_site.json,sha256=AVUl5x9jLL0FcStbTR-FMy-_A7uM-VlrJ-kdCBXWz_g,1755
14
+ source_google_search_console/schemas/search_analytics_page_report.json,sha256=-b0Y0LenTchS0q9A2aQ4hIjUjXkYF8erOtyrTMhf6MM,1776
15
+ source_google_search_console/schemas/search_analytics_site_report_by_page.json,sha256=hWKHkm1reqGGu1dNcWBe6_XkZ5tK-UaiymrYRVgxRxI,1515
16
+ source_google_search_console/schemas/search_analytics_site_report_by_site.json,sha256=rAh6LuNy7nCrrNM9MTd0qxAVc886ecQaqWRgV63OfyA,1408
17
+ source_google_search_console/schemas/sitemaps.json,sha256=coyPSZCAfzMheybfRp4WPAZCp5JF2KGRF2rWK8oC080,1775
18
+ source_google_search_console/schemas/sites.json,sha256=WNiCRuStPL1YkJiFa8FEbNJmqaERAOf9Yow6ygIumvo,383
19
19
  source_google_search_console/service_account_authenticator.py,sha256=ocSisT5IYegoZf4atsGm9u2lJCdmeSf_9o4q7YN3vD4,1225
20
20
  source_google_search_console/source.py,sha256=TEqjXQr_X_8J0fPrLhQVIzIIgfspF7sgLUjAjKNtY-Q,10013
21
21
  source_google_search_console/spec.json,sha256=WYtFvaSqWYGm1Dt2yV9G92U78Q94rh9oarbxJe3H7xo,8470
22
22
  source_google_search_console/streams.py,sha256=IyJ2lvLkC9axG-OS5cPzYantmIAwci8ltwDzy10kTdI,18404
23
- airbyte_source_google_search_console-1.3.7.dist-info/METADATA,sha256=7JgbLYr5WXneVxUhuYFLAAmqft1QC5SqKsNBsFiQUgw,5609
24
- airbyte_source_google_search_console-1.3.7.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
25
- airbyte_source_google_search_console-1.3.7.dist-info/entry_points.txt,sha256=DMcgc9bCX-Vt6hm_68pa77qS3eGdeMhg-UdlFc-XKUM,85
26
- airbyte_source_google_search_console-1.3.7.dist-info/RECORD,,
23
+ airbyte_source_google_search_console-1.4.2.dist-info/METADATA,sha256=L4Sd4OZ-21Rs0DN-21M4D9UYmIEZmHKB06gGGus4_PI,5609
24
+ airbyte_source_google_search_console-1.4.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
25
+ airbyte_source_google_search_console-1.4.2.dist-info/entry_points.txt,sha256=DMcgc9bCX-Vt6hm_68pa77qS3eGdeMhg-UdlFc-XKUM,85
26
+ airbyte_source_google_search_console-1.4.2.dist-info/RECORD,,
@@ -3,38 +3,49 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "site_url": {
6
+ "description": "The URL of the site from which the data originates.",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "search_type": {
10
+ "description": "The type of search (e.g., web, image, video) that triggered the search result.",
9
11
  "type": ["null", "string"]
10
12
  },
11
13
  "date": {
14
+ "description": "The date when the search query occurred.",
12
15
  "type": ["null", "string"],
13
16
  "format": "date"
14
17
  },
15
18
  "country": {
19
+ "description": "The country from which the search query originated.",
16
20
  "type": ["null", "string"]
17
21
  },
18
22
  "device": {
23
+ "description": "The type of device used by the user (e.g., desktop, mobile).",
19
24
  "type": ["null", "string"]
20
25
  },
21
26
  "page": {
27
+ "description": "The page URL that appeared in the search results.",
22
28
  "type": ["null", "string"]
23
29
  },
24
30
  "query": {
31
+ "description": "The search query entered by the user.",
25
32
  "type": ["null", "string"]
26
33
  },
27
34
  "clicks": {
35
+ "description": "The number of times users clicked on the search result for a specific query.",
28
36
  "type": ["null", "integer"]
29
37
  },
30
38
  "impressions": {
39
+ "description": "The number of times a search result appeared in response to a query.",
31
40
  "type": ["null", "integer"]
32
41
  },
33
42
  "ctr": {
43
+ "description": "Click-through rate, calculated as clicks divided by impressions.",
34
44
  "type": ["null", "number"],
35
45
  "multipleOf": 1e-25
36
46
  },
37
47
  "position": {
48
+ "description": "The average position of the search result on the search engine results page.",
38
49
  "type": ["null", "number"],
39
50
  "multipleOf": 1e-25
40
51
  }
@@ -3,29 +3,37 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "site_url": {
6
+ "description": "The URL of the site for which the search analytics data is being reported.",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "search_type": {
10
+ "description": "The type of search (web search, image search, video search, etc.) for which the data is being reported.",
9
11
  "type": ["null", "string"]
10
12
  },
11
13
  "date": {
14
+ "description": "The date for which the search analytics data is being reported.",
12
15
  "type": ["null", "string"],
13
16
  "format": "date"
14
17
  },
15
18
  "country": {
19
+ "description": "The country for which the search analytics data is being reported.",
16
20
  "type": ["null", "string"]
17
21
  },
18
22
  "clicks": {
23
+ "description": "The number of times users clicked on the search result for a specific country.",
19
24
  "type": ["null", "integer"]
20
25
  },
21
26
  "impressions": {
27
+ "description": "The total number of times a search result was shown in search results for a specific country.",
22
28
  "type": ["null", "integer"]
23
29
  },
24
30
  "ctr": {
31
+ "description": "The click-through rate, i.e., the ratio of clicks to impressions for a specific country.",
25
32
  "type": ["null", "number"],
26
33
  "multipleOf": 1e-25
27
34
  },
28
35
  "position": {
36
+ "description": "The average position at which the site's search result appeared for a specific country.",
29
37
  "type": ["null", "number"],
30
38
  "multipleOf": 1e-25
31
39
  }
@@ -3,26 +3,33 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "site_url": {
6
+ "description": "The URL of the site for which the search analytics data is being reported.",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "search_type": {
10
+ "description": "The type of search query (e.g., web, image, video) that generated the search analytics data.",
9
11
  "type": ["null", "string"]
10
12
  },
11
13
  "date": {
14
+ "description": "The date for which the search analytics data is being reported.",
12
15
  "type": ["null", "string"],
13
16
  "format": "date"
14
17
  },
15
18
  "clicks": {
19
+ "description": "The total number of times users clicked on the search result for the site URL on the specific date.",
16
20
  "type": ["null", "integer"]
17
21
  },
18
22
  "impressions": {
23
+ "description": "The number of times the site URL was displayed in the search results to users on the specific date.",
19
24
  "type": ["null", "integer"]
20
25
  },
21
26
  "ctr": {
27
+ "description": "The click-through rate (CTR) represents the percentage of total impressions that resulted in a click to the site URL.",
22
28
  "type": ["null", "number"],
23
29
  "multipleOf": 1e-25
24
30
  },
25
31
  "position": {
32
+ "description": "The average position of the site URL in the search results pages for the specific date.",
26
33
  "type": ["null", "number"],
27
34
  "multipleOf": 1e-25
28
35
  }
@@ -3,29 +3,37 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "site_url": {
6
+ "description": "The URL of the site for which search analytics data is being provided.",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "search_type": {
10
+ "description": "The type of search performed (e.g., web search, image search, video search).",
9
11
  "type": ["null", "string"]
10
12
  },
11
13
  "date": {
14
+ "description": "The date for which the search analytics data is provided.",
12
15
  "type": ["null", "string"],
13
16
  "format": "date"
14
17
  },
15
18
  "device": {
19
+ "description": "The type of device used by the user for the search query (e.g., desktop, mobile).",
16
20
  "type": ["null", "string"]
17
21
  },
18
22
  "clicks": {
23
+ "description": "The total number of times a user clicked on a search result linking to the target site.",
19
24
  "type": ["null", "integer"]
20
25
  },
21
26
  "impressions": {
27
+ "description": "The total number of times a user saw a link to the target site in search results.",
22
28
  "type": ["null", "integer"]
23
29
  },
24
30
  "ctr": {
31
+ "description": "Click-through rate represents the ratio of clicks to impressions, showing the effectiveness of your site in attracting clicks from search results.",
25
32
  "type": ["null", "number"],
26
33
  "multipleOf": 1e-25
27
34
  },
28
35
  "position": {
36
+ "description": "The average position of the site's URLs in search results for the given query or queries.",
29
37
  "type": ["null", "number"],
30
38
  "multipleOf": 1e-25
31
39
  }
@@ -3,29 +3,37 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "site_url": {
6
+ "description": "The URL of the site for which the search analytics data is being reported.",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "search_type": {
10
+ "description": "The type of search query that led to the page being displayed in search results.",
9
11
  "type": ["null", "string"]
10
12
  },
11
13
  "date": {
14
+ "description": "The date for which the search analytics data is reported.",
12
15
  "type": ["null", "string"],
13
16
  "format": "date"
14
17
  },
15
18
  "page": {
19
+ "description": "The URL of the specific page being analyzed for search analytics data.",
16
20
  "type": ["null", "string"]
17
21
  },
18
22
  "clicks": {
23
+ "description": "The number of times a user clicked on the search result linking to the page.",
19
24
  "type": ["null", "integer"]
20
25
  },
21
26
  "impressions": {
27
+ "description": "The number of times a page from the site appeared in the search results viewed by users.",
22
28
  "type": ["null", "integer"]
23
29
  },
24
30
  "ctr": {
31
+ "description": "Click-through rate (CTR) is the ratio of clicks to impressions, indicating the effectiveness of the page in generating clicks.",
25
32
  "type": ["null", "number"],
26
33
  "multipleOf": 1e-25
27
34
  },
28
35
  "position": {
36
+ "description": "The average position at which the page appeared in search results.",
29
37
  "type": ["null", "number"],
30
38
  "multipleOf": 1e-25
31
39
  }
@@ -3,29 +3,37 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "site_url": {
6
+ "description": "The URL of the site for which the search analytics data is captured.",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "search_type": {
10
+ "description": "The type of search result (e.g., web, image, video) for the specific query.",
9
11
  "type": ["null", "string"]
10
12
  },
11
13
  "date": {
14
+ "description": "The date for which the search analytics data is recorded.",
12
15
  "type": ["null", "string"],
13
16
  "format": "date"
14
17
  },
15
18
  "query": {
19
+ "description": "The search query for which the search analytics data is recorded.",
16
20
  "type": ["null", "string"]
17
21
  },
18
22
  "clicks": {
23
+ "description": "The number of times users clicked on the search result for the specific query.",
19
24
  "type": ["null", "integer"]
20
25
  },
21
26
  "impressions": {
27
+ "description": "The number of times the search result was displayed for the specific query.",
22
28
  "type": ["null", "integer"]
23
29
  },
24
30
  "ctr": {
31
+ "description": "The click-through rate (percentage) for the specific query, calculated as clicks divided by impressions.",
25
32
  "type": ["null", "number"],
26
33
  "multipleOf": 1e-25
27
34
  },
28
35
  "position": {
36
+ "description": "The average position at which the search result appeared for the specific query.",
29
37
  "type": ["null", "number"],
30
38
  "multipleOf": 1e-25
31
39
  }
@@ -4,38 +4,49 @@
4
4
  "additionalProperties": true,
5
5
  "properties": {
6
6
  "site_url": {
7
+ "description": "The URL of the website being monitored.",
7
8
  "type": ["null", "string"]
8
9
  },
9
10
  "search_type": {
11
+ "description": "The type of search (e.g., web, image, video).",
10
12
  "type": ["null", "string"]
11
13
  },
12
14
  "date": {
15
+ "description": "The date of the search data collected.",
13
16
  "type": ["null", "string"],
14
17
  "format": "date"
15
18
  },
16
19
  "country": {
20
+ "description": "The country where the search is made.",
17
21
  "type": ["null", "string"]
18
22
  },
19
23
  "device": {
24
+ "description": "The device type used for the search (e.g., desktop, mobile).",
20
25
  "type": ["null", "string"]
21
26
  },
22
27
  "page": {
28
+ "description": "The page URL on which the keyword appears in search results.",
23
29
  "type": ["null", "string"]
24
30
  },
25
31
  "query": {
32
+ "description": "The search query used to find the site.",
26
33
  "type": ["null", "string"]
27
34
  },
28
35
  "clicks": {
36
+ "description": "The number of clicks for the keyword on a specific page.",
29
37
  "type": ["null", "integer"]
30
38
  },
31
39
  "impressions": {
40
+ "description": "The number of times the keyword appeared in search results.",
32
41
  "type": ["null", "integer"]
33
42
  },
34
43
  "ctr": {
44
+ "description": "Click-through rate which is the percentage of clicks divided by impressions.",
35
45
  "type": ["null", "number"],
36
46
  "multipleOf": 1e-25
37
47
  },
38
48
  "position": {
49
+ "description": "The average position of the keyword on search results pages.",
39
50
  "type": ["null", "number"],
40
51
  "multipleOf": 1e-25
41
52
  }
@@ -4,35 +4,45 @@
4
4
  "additionalProperties": true,
5
5
  "properties": {
6
6
  "site_url": {
7
+ "description": "The URL of the website for which the search analytics data is retrieved.",
7
8
  "type": ["null", "string"]
8
9
  },
9
10
  "search_type": {
11
+ "description": "The type of search conducted (e.g., web, image, video).",
10
12
  "type": ["null", "string"]
11
13
  },
12
14
  "date": {
15
+ "description": "The date when the search data was recorded.",
13
16
  "type": ["null", "string"],
14
17
  "format": "date"
15
18
  },
16
19
  "country": {
20
+ "description": "The country from which the search query originated.",
17
21
  "type": ["null", "string"]
18
22
  },
19
23
  "device": {
24
+ "description": "The device type used for the search query (e.g., desktop, mobile).",
20
25
  "type": ["null", "string"]
21
26
  },
22
27
  "query": {
28
+ "description": "The search query used by the user.",
23
29
  "type": ["null", "string"]
24
30
  },
25
31
  "clicks": {
32
+ "description": "The number of times users clicked on your website link in search results.",
26
33
  "type": ["null", "integer"]
27
34
  },
28
35
  "impressions": {
36
+ "description": "The number of times your website link appeared in search results.",
29
37
  "type": ["null", "integer"]
30
38
  },
31
39
  "ctr": {
40
+ "description": "Click-through rate: Number of clicks divided by the number of impressions.",
32
41
  "type": ["null", "number"],
33
42
  "multipleOf": 1e-25
34
43
  },
35
44
  "position": {
45
+ "description": "The average position of your website link in search results.",
36
46
  "type": ["null", "number"],
37
47
  "multipleOf": 1e-25
38
48
  }
@@ -4,35 +4,45 @@
4
4
  "additionalProperties": true,
5
5
  "properties": {
6
6
  "site_url": {
7
+ "description": "The URL of the site for which the search analytics data is recorded.",
7
8
  "type": ["null", "string"]
8
9
  },
9
10
  "search_type": {
11
+ "description": "The type of search (e.g., web search, image search) that generated the analytics data.",
10
12
  "type": ["null", "string"]
11
13
  },
12
14
  "date": {
15
+ "description": "The date for which the search analytics data is recorded.",
13
16
  "type": ["null", "string"],
14
17
  "format": "date"
15
18
  },
16
19
  "country": {
20
+ "description": "The country from which the search originated.",
17
21
  "type": ["null", "string"]
18
22
  },
19
23
  "device": {
24
+ "description": "The type of device used by the user during the search (e.g., desktop, mobile).",
20
25
  "type": ["null", "string"]
21
26
  },
22
27
  "query": {
28
+ "description": "The search query used by the user to find the site in search results.",
23
29
  "type": ["null", "string"]
24
30
  },
25
31
  "clicks": {
32
+ "description": "The number of times users clicked on the search result linking to the site.",
26
33
  "type": ["null", "integer"]
27
34
  },
28
35
  "impressions": {
36
+ "description": "The number of times the site was shown in search results to users.",
29
37
  "type": ["null", "integer"]
30
38
  },
31
39
  "ctr": {
40
+ "description": "Click-through rate represents the percentage of users who clicked on the site's link after seeing it in search results.",
32
41
  "type": ["null", "number"],
33
42
  "multipleOf": 1e-25
34
43
  },
35
44
  "position": {
45
+ "description": "The average ranking position of the site in search results.",
36
46
  "type": ["null", "number"],
37
47
  "multipleOf": 1e-25
38
48
  }
@@ -4,35 +4,45 @@
4
4
  "additionalProperties": true,
5
5
  "properties": {
6
6
  "site_url": {
7
+ "description": "The URL of the website for which the search analytics data is being reported.",
7
8
  "type": ["null", "string"]
8
9
  },
9
10
  "search_type": {
11
+ "description": "The type of search (e.g., web, image, video) that led users to the website.",
10
12
  "type": ["null", "string"]
11
13
  },
12
14
  "date": {
15
+ "description": "The date when the search data was recorded.",
13
16
  "type": ["null", "string"],
14
17
  "format": "date"
15
18
  },
16
19
  "country": {
20
+ "description": "The country from which the search originated.",
17
21
  "type": ["null", "string"]
18
22
  },
19
23
  "page": {
24
+ "description": "The specific page URL within the website that appeared in search results.",
20
25
  "type": ["null", "string"]
21
26
  },
22
27
  "device": {
28
+ "description": "The type of device used by the user for the search query (e.g., desktop, mobile).",
23
29
  "type": ["null", "string"]
24
30
  },
25
31
  "clicks": {
32
+ "description": "The total number of times users clicked on search results that led to the linked website.",
26
33
  "type": ["null", "integer"]
27
34
  },
28
35
  "impressions": {
36
+ "description": "The total number of times a search result from the linked website was shown to users.",
29
37
  "type": ["null", "integer"]
30
38
  },
31
39
  "ctr": {
40
+ "description": "Click-through rate: The percentage of clicks out of the total impressions for a given search query.",
32
41
  "type": ["null", "number"],
33
42
  "multipleOf": 1e-25
34
43
  },
35
44
  "position": {
45
+ "description": "The average position at which the website's search results appeared to users.",
36
46
  "type": ["null", "number"],
37
47
  "multipleOf": 1e-25
38
48
  }
@@ -4,32 +4,41 @@
4
4
  "additionalProperties": true,
5
5
  "properties": {
6
6
  "site_url": {
7
+ "description": "The URL of the page on the site that is being reported.",
7
8
  "type": ["null", "string"]
8
9
  },
9
10
  "search_type": {
11
+ "description": "The type of search query that led to the page being shown.",
10
12
  "type": ["null", "string"]
11
13
  },
12
14
  "date": {
15
+ "description": "The date for which the data is being reported.",
13
16
  "type": ["null", "string"],
14
17
  "format": "date"
15
18
  },
16
19
  "country": {
20
+ "description": "The country from which the search traffic originated.",
17
21
  "type": ["null", "string"]
18
22
  },
19
23
  "device": {
24
+ "description": "The type of device used by the searcher (e.g., desktop, mobile).",
20
25
  "type": ["null", "string"]
21
26
  },
22
27
  "clicks": {
28
+ "description": "The total number of clicks received by the page from search results.",
23
29
  "type": ["null", "integer"]
24
30
  },
25
31
  "impressions": {
32
+ "description": "The total number of times the page appeared in search results.",
26
33
  "type": ["null", "integer"]
27
34
  },
28
35
  "ctr": {
36
+ "description": "The click-through rate, i.e., the percentage of total impressions that resulted in clicks.",
29
37
  "type": ["null", "number"],
30
38
  "multipleOf": 1e-25
31
39
  },
32
40
  "position": {
41
+ "description": "The average position at which the page appeared in search results.",
33
42
  "type": ["null", "number"],
34
43
  "multipleOf": 1e-25
35
44
  }
@@ -4,32 +4,41 @@
4
4
  "additionalProperties": true,
5
5
  "properties": {
6
6
  "site_url": {
7
+ "description": "The URL of the site being analyzed",
7
8
  "type": ["null", "string"]
8
9
  },
9
10
  "search_type": {
11
+ "description": "The type of search (e.g., web, image, video)",
10
12
  "type": ["null", "string"]
11
13
  },
12
14
  "date": {
15
+ "description": "The date of the search analytics data",
13
16
  "type": ["null", "string"],
14
17
  "format": "date"
15
18
  },
16
19
  "country": {
20
+ "description": "The country where the search took place",
17
21
  "type": ["null", "string"]
18
22
  },
19
23
  "device": {
24
+ "description": "The type of device used for the search (e.g., mobile, desktop)",
20
25
  "type": ["null", "string"]
21
26
  },
22
27
  "clicks": {
28
+ "description": "The number of times users clicked on a search result linking to the site",
23
29
  "type": ["null", "integer"]
24
30
  },
25
31
  "impressions": {
32
+ "description": "The number of times the site appeared in search results",
26
33
  "type": ["null", "integer"]
27
34
  },
28
35
  "ctr": {
36
+ "description": "Click-through rate calculated as clicks divided by impressions",
29
37
  "type": ["null", "number"],
30
38
  "multipleOf": 1e-25
31
39
  },
32
40
  "position": {
41
+ "description": "The average position of the site in search results",
33
42
  "type": ["null", "number"],
34
43
  "multipleOf": 1e-25
35
44
  }
@@ -3,43 +3,55 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "path": {
6
+ "description": "Path to the sitemap file",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "lastSubmitted": {
10
+ "description": "Timestamp when the sitemap was last submitted",
9
11
  "type": ["null", "string"],
10
12
  "format": "date-time"
11
13
  },
12
14
  "isPending": {
15
+ "description": "Flag indicating if the sitemap is pending for processing",
13
16
  "type": ["null", "boolean"]
14
17
  },
15
18
  "isSitemapsIndex": {
19
+ "description": "Flag indicating if the data represents a sitemap index",
16
20
  "type": ["null", "boolean"]
17
21
  },
18
22
  "type": {
23
+ "description": "Type of the sitemap",
19
24
  "type": ["null", "string"]
20
25
  },
21
26
  "lastDownloaded": {
27
+ "description": "Timestamp when the sitemap was last downloaded",
22
28
  "type": ["null", "string"],
23
29
  "format": "date-time"
24
30
  },
25
31
  "warnings": {
32
+ "description": "Warnings encountered while processing the sitemaps",
26
33
  "type": ["null", "string"]
27
34
  },
28
35
  "errors": {
36
+ "description": "Errors encountered while processing the sitemaps",
29
37
  "type": ["null", "string"]
30
38
  },
31
39
  "contents": {
40
+ "description": "Data related to the sitemap contents",
32
41
  "type": "array",
33
42
  "items": {
34
43
  "type": "object",
35
44
  "properties": {
36
45
  "type": {
46
+ "description": "Type of the sitemap content",
37
47
  "type": ["null", "string"]
38
48
  },
39
49
  "submitted": {
50
+ "description": "Number of submitted sitemap URLs",
40
51
  "type": ["null", "string"]
41
52
  },
42
53
  "indexed": {
54
+ "description": "Number of indexed sitemap URLs",
43
55
  "type": ["null", "string"]
44
56
  }
45
57
  }
@@ -3,9 +3,11 @@
3
3
  "type": "object",
4
4
  "properties": {
5
5
  "siteUrl": {
6
+ "description": "The URL of the site data being fetched",
6
7
  "type": ["null", "string"]
7
8
  },
8
9
  "permissionLevel": {
10
+ "description": "The user's permission level for the site (owner, full, restricted, etc.)",
9
11
  "type": ["null", "string"]
10
12
  }
11
13
  }