{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/analytics:googleapis-customsearch/search-cse-list":{"get":{"operationId":"analytics_googleapis_customsearch_search_cse_list","summary":"Returns metadata about the search performed, metadata about the engine used for the search, and the search…","description":"GET /customsearch/v1","tags":["analytics"],"parameters":[{"name":"c2coff","in":"query","required":false,"description":"Enables or disables [Simplified and Traditional Chinese…","schema":{"type":"string","description":"Enables or disables [Simplified and Traditional Chinese…"}},{"name":"cr","in":"query","required":false,"description":"Restricts search results to documents originating in a particular country. You may use [Boolean…","schema":{"type":"string","description":"Restricts search results to documents originating in a particular country. You may use [Boolean…"}},{"name":"cx","in":"query","required":false,"description":"The Programmable Search Engine ID to use for this request.","schema":{"type":"string","description":"The Programmable Search Engine ID to use for this request."}},{"name":"dateRestrict","in":"query","required":false,"description":"Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days.…","schema":{"type":"string","description":"Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days.…"}},{"name":"enableAlternateSearchHandler","in":"query","required":false,"description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.","schema":{"type":"boolean","description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler."}},{"name":"exactTerms","in":"query","required":false,"description":"Identifies a phrase that all documents in the search results must contain.","schema":{"type":"string","description":"Identifies a phrase that all documents in the search results must contain."}},{"name":"excludeTerms","in":"query","required":false,"description":"Identifies a word or phrase that should not appear in any documents in the search results.","schema":{"type":"string","description":"Identifies a word or phrase that should not appear in any documents in the search results."}},{"name":"fileType","in":"query","required":false,"description":"Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help…","schema":{"type":"string","description":"Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help…"}},{"name":"filter","in":"query","required":false,"description":"Controls turning on or off the duplicate content filter. * See [Automatic…","schema":{"type":"string","description":"Controls turning on or off the duplicate content filter. * See [Automatic…"}},{"name":"gl","in":"query","required":false,"description":"Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country…","schema":{"type":"string","description":"Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country…"}},{"name":"googlehost","in":"query","required":false,"description":"**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to…","schema":{"type":"string","description":"**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to…"}},{"name":"highRange","in":"query","required":false,"description":"Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of…","schema":{"type":"string","description":"Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of…"}},{"name":"hl","in":"query","required":false,"description":"Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. *…","schema":{"type":"string","description":"Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. *…"}},{"name":"hq","in":"query","required":false,"description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator.","schema":{"type":"string","description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator."}},{"name":"imgColorType","in":"query","required":false,"description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and…","schema":{"type":"string","enum":["imgColorTypeUndefined","mono","gray","color","trans"],"description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and…"}},{"name":"imgDominantColor","in":"query","required":false,"description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"`…","schema":{"type":"string","enum":["imgDominantColorUndefined","black","blue","brown","gray","green","orange","pink","purple","red","teal","white","yellow"],"description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"`…"}},{"name":"imgSize","in":"query","required":false,"description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` *…","schema":{"type":"string","enum":["imgSizeUndefined","HUGE","ICON","LARGE","MEDIUM","SMALL","XLARGE","XXLARGE"],"description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` *…"}},{"name":"imgType","in":"query","required":false,"description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`","schema":{"type":"string","enum":["imgTypeUndefined","clipart","face","lineart","stock","photo","animated"],"description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`"}},{"name":"linkSite","in":"query","required":false,"description":"Specifies that all search results should contain a link to a particular URL.","schema":{"type":"string","description":"Specifies that all search results should contain a link to a particular URL."}},{"name":"lowRange","in":"query","required":false,"description":"Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of…","schema":{"type":"string","description":"Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of…"}},{"name":"lr","in":"query","required":false,"description":"Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic *…","schema":{"type":"string","description":"Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic *…"}},{"name":"num","in":"query","required":false,"description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive.","schema":{"type":"integer","description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive."}},{"name":"orTerms","in":"query","required":false,"description":"Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the…","schema":{"type":"string","description":"Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the…"}},{"name":"q","in":"query","required":false,"description":"Query","schema":{"type":"string","description":"Query"}},{"name":"relatedSite","in":"query","required":false,"description":"Deprecated.","schema":{"type":"string","description":"Deprecated."}},{"name":"rights","in":"query","required":false,"description":"Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`,…","schema":{"type":"string","description":"Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`,…"}},{"name":"safe","in":"query","required":false,"description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)","schema":{"type":"string","enum":["safeUndefined","active","high","medium","off"],"description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)"}},{"name":"searchType","in":"query","required":false,"description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image…","schema":{"type":"string","enum":["searchTypeUndefined","image"],"description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image…"}},{"name":"siteSearch","in":"query","required":false,"description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).","schema":{"type":"string","description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below)."}},{"name":"siteSearchFilter","in":"query","required":false,"description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude…","schema":{"type":"string","enum":["siteSearchFilterUndefined","e","i"],"description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude…"}},{"name":"snippetLength","in":"query","required":false,"description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. *…","schema":{"type":"integer","description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. *…"}},{"name":"sort","in":"query","required":false,"description":"The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression…","schema":{"type":"string","description":"The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression…"}},{"name":"start","in":"query","required":false,"description":"The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second…","schema":{"type":"integer","description":"The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/analytics:googleapis-customsearch/search-cse-siterestrict-list":{"get":{"operationId":"analytics_googleapis_customsearch_search_cse_siterestrict_list","summary":"Returns metadata about the search performed, metadata about the engine used for the search, and the search…","description":"GET /customsearch/v1/siterestrict","tags":["analytics"],"parameters":[{"name":"c2coff","in":"query","required":false,"description":"Enables or disables [Simplified and Traditional Chinese…","schema":{"type":"string","description":"Enables or disables [Simplified and Traditional Chinese…"}},{"name":"cr","in":"query","required":false,"description":"Restricts search results to documents originating in a particular country. You may use [Boolean…","schema":{"type":"string","description":"Restricts search results to documents originating in a particular country. You may use [Boolean…"}},{"name":"cx","in":"query","required":false,"description":"The Programmable Search Engine ID to use for this request.","schema":{"type":"string","description":"The Programmable Search Engine ID to use for this request."}},{"name":"dateRestrict","in":"query","required":false,"description":"Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days.…","schema":{"type":"string","description":"Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days.…"}},{"name":"enableAlternateSearchHandler","in":"query","required":false,"description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler.","schema":{"type":"boolean","description":"Optional. Enables routing of Programmable Search Engine requests to an alternate search handler."}},{"name":"exactTerms","in":"query","required":false,"description":"Identifies a phrase that all documents in the search results must contain.","schema":{"type":"string","description":"Identifies a phrase that all documents in the search results must contain."}},{"name":"excludeTerms","in":"query","required":false,"description":"Identifies a word or phrase that should not appear in any documents in the search results.","schema":{"type":"string","description":"Identifies a word or phrase that should not appear in any documents in the search results."}},{"name":"fileType","in":"query","required":false,"description":"Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help…","schema":{"type":"string","description":"Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help…"}},{"name":"filter","in":"query","required":false,"description":"Controls turning on or off the duplicate content filter. * See [Automatic…","schema":{"type":"string","description":"Controls turning on or off the duplicate content filter. * See [Automatic…"}},{"name":"gl","in":"query","required":false,"description":"Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country…","schema":{"type":"string","description":"Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country…"}},{"name":"googlehost","in":"query","required":false,"description":"**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to…","schema":{"type":"string","description":"**Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to…"}},{"name":"highRange","in":"query","required":false,"description":"Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of…","schema":{"type":"string","description":"Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of…"}},{"name":"hl","in":"query","required":false,"description":"Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. *…","schema":{"type":"string","description":"Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. *…"}},{"name":"hq","in":"query","required":false,"description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator.","schema":{"type":"string","description":"Appends the specified query terms to the query, as if they were combined with a logical AND operator."}},{"name":"imgColorType","in":"query","required":false,"description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and…","schema":{"type":"string","enum":["imgColorTypeUndefined","mono","gray","color","trans"],"description":"Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `\"color\"` * `\"gray\"` * `\"mono\"`: black and…"}},{"name":"imgDominantColor","in":"query","required":false,"description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"`…","schema":{"type":"string","enum":["imgDominantColorUndefined","black","blue","brown","gray","green","orange","pink","purple","red","teal","white","yellow"],"description":"Returns images of a specific dominant color. Acceptable values are: * `\"black\"` * `\"blue\"` * `\"brown\"` * `\"gray\"` * `\"green\"` * `\"orange\"`…"}},{"name":"imgSize","in":"query","required":false,"description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` *…","schema":{"type":"string","enum":["imgSizeUndefined","HUGE","ICON","LARGE","MEDIUM","SMALL","XLARGE","XXLARGE"],"description":"Returns images of a specified size. Acceptable values are: * `\"huge\"` * `\"icon\"` * `\"large\"` * `\"medium\"` * `\"small\"` * `\"xlarge\"` *…"}},{"name":"imgType","in":"query","required":false,"description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`","schema":{"type":"string","enum":["imgTypeUndefined","clipart","face","lineart","stock","photo","animated"],"description":"Returns images of a type. Acceptable values are: * `\"clipart\"` * `\"face\"` * `\"lineart\"` * `\"stock\"` * `\"photo\"` * `\"animated\"`"}},{"name":"linkSite","in":"query","required":false,"description":"Specifies that all search results should contain a link to a particular URL.","schema":{"type":"string","description":"Specifies that all search results should contain a link to a particular URL."}},{"name":"lowRange","in":"query","required":false,"description":"Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of…","schema":{"type":"string","description":"Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of…"}},{"name":"lr","in":"query","required":false,"description":"Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic *…","schema":{"type":"string","description":"Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `\"lang_ar\"`: Arabic *…"}},{"name":"num","in":"query","required":false,"description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive.","schema":{"type":"integer","description":"Number of search results to return. * Valid values are integers between 1 and 10, inclusive."}},{"name":"orTerms","in":"query","required":false,"description":"Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the…","schema":{"type":"string","description":"Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the…"}},{"name":"q","in":"query","required":false,"description":"Query","schema":{"type":"string","description":"Query"}},{"name":"relatedSite","in":"query","required":false,"description":"Deprecated.","schema":{"type":"string","description":"Deprecated."}},{"name":"rights","in":"query","required":false,"description":"Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`,…","schema":{"type":"string","description":"Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`,…"}},{"name":"safe","in":"query","required":false,"description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)","schema":{"type":"string","enum":["safeUndefined","active","high","medium","off"],"description":"Search safety level. Acceptable values are: * `\"active\"`: Enables SafeSearch filtering. * `\"off\"`: Disables SafeSearch filtering. (default)"}},{"name":"searchType","in":"query","required":false,"description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image…","schema":{"type":"string","enum":["searchTypeUndefined","image"],"description":"Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `\"image\"`: custom image…"}},{"name":"siteSearch","in":"query","required":false,"description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below).","schema":{"type":"string","description":"Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below)."}},{"name":"siteSearchFilter","in":"query","required":false,"description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude…","schema":{"type":"string","enum":["siteSearchFilterUndefined","e","i"],"description":"Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `\"e\"`: exclude…"}},{"name":"snippetLength","in":"query","required":false,"description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. *…","schema":{"type":"integer","description":"Optional. Maximum length of snippet text, in characters, to be returned with results. Note: this feature is limited to specific engines. *…"}},{"name":"sort","in":"query","required":false,"description":"The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression…","schema":{"type":"string","description":"The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression…"}},{"name":"start","in":"query","required":false,"description":"The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second…","schema":{"type":"integer","description":"The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}