{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:opendatasoft/get-root":{"get":{"operationId":"open_data_opendatasoft_get_root","summary":"API entry point Provides links for: * catalog, your domain's list of datasets * opendatasoft, all datasets…","description":"GET /","tags":["open-data"],"parameters":[],"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/open-data:opendatasoft/get-pages":{"get":{"operationId":"open_data_opendatasoft_get_pages","summary":"List of all pages from this portal.","description":"GET /pages","tags":["open-data"],"parameters":[],"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/open-data:opendatasoft/get-page":{"get":{"operationId":"open_data_opendatasoft_get_page","summary":"A single page's metadata from this portal","description":"GET /pages/{slug}","tags":["open-data"],"parameters":[{"name":"slug","in":"query","required":true,"description":"Page slug.","schema":{"type":"string","description":"Page slug."}}],"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/open-data:opendatasoft/get-source":{"get":{"operationId":"open_data_opendatasoft_get_source","summary":"Source entry points Provides links for the source's datasets and metadata.","description":"GET /{source}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}}],"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/open-data:opendatasoft/aggregate-datasets":{"get":{"operationId":"open_data_opendatasoft_aggregate_datasets","summary":"**Deprecated, use `/datasets` instead.**","description":"GET /{source}/aggregates","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"group_by","in":"query","required":false,"description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…","schema":{"type":"string","description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}}],"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/open-data:opendatasoft/get-datasets":{"get":{"operationId":"open_data_opendatasoft_get_datasets","summary":"List of available datasets, each with their endpoints, paginated. Links provided: * previous page * next…","description":"GET /{source}/datasets","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"group_by","in":"query","required":false,"description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…","schema":{"type":"string","description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/get-dataset":{"get":{"operationId":"open_data_opendatasoft_get_dataset","summary":"List of available endpoints for the specified dataset, with metadata and endpoints. Will provide links for:…","description":"GET /{source}/datasets/{dataset_id}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/aggregate-records":{"get":{"operationId":"open_data_opendatasoft_aggregate_records","summary":"**Deprecated, use `/records` instead.**","description":"GET /{source}/datasets/{dataset_id}/aggregates","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"group_by","in":"query","required":false,"description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…","schema":{"type":"string","description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}}],"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/open-data:opendatasoft/get-dataset-attachements":{"get":{"operationId":"open_data_opendatasoft_get_dataset_attachements","summary":"Get list of all available attachments","description":"GET /{source}/datasets/{dataset_id}/attachments","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}}],"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/open-data:opendatasoft/download-dataset-attachement":{"get":{"operationId":"open_data_opendatasoft_download_dataset_attachement","summary":"Download attachment","description":"GET /{source}/datasets/{dataset_id}/attachments/{attachment_id}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"attachment_id","in":"query","required":true,"schema":{"type":"string"}}],"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/open-data:opendatasoft/export-records-csv":{"get":{"operationId":"open_data_opendatasoft_export_records_csv","summary":"Export dataset in CSV format","description":"GET /{source}/datasets/{dataset_id}/exports/csv","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"delimiter","in":"query","required":false,"description":"Provide a different delimiter (default ',').","schema":{"type":"string","enum":[",",";","|"],"default":";","description":"Provide a different delimiter (default ',')."}}],"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/open-data:opendatasoft/export-records-geojson":{"get":{"operationId":"open_data_opendatasoft_export_records_geojson","summary":"Export dataset in GEOJSON format","description":"GET /{source}/datasets/{dataset_id}/exports/geojson","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}}],"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/open-data:opendatasoft/export-records-ical":{"get":{"operationId":"open_data_opendatasoft_export_records_ical","summary":"Export dataset in ICAL format","description":"GET /{source}/datasets/{dataset_id}/exports/ical","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/export-records-json":{"get":{"operationId":"open_data_opendatasoft_export_records_json","summary":"Export dataset in JSON format","description":"GET /{source}/datasets/{dataset_id}/exports/json","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/export-records-ov2":{"get":{"operationId":"open_data_opendatasoft_export_records_ov2","summary":"Export dataset in OV2 format","description":"GET /{source}/datasets/{dataset_id}/exports/ov2","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/export-records-shp":{"get":{"operationId":"open_data_opendatasoft_export_records_shp","summary":"Export dataset in Esri shapefile (shp) format","description":"GET /{source}/datasets/{dataset_id}/exports/shp","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/export-records-xls":{"get":{"operationId":"open_data_opendatasoft_export_records_xls","summary":"Export dataset in XLS (Excel) format","description":"GET /{source}/datasets/{dataset_id}/exports/xls","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return in export. Use -1 (default) to retrieve all records","schema":{"type":"integer","default":-1,"description":"Number of items to return in export. Use -1 (default) to retrieve all records"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/get-records-facets":{"get":{"operationId":"open_data_opendatasoft_get_records_facets","summary":"Enumerate facets values for records and return a list of values for each facet. Can be used to implement…","description":"GET /{source}/datasets/{dataset_id}/facets","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/send-dataset-feedback":{"post":{"operationId":"open_data_opendatasoft_send_dataset_feedback","summary":"Create new feedback entry.","description":"PUT /{source}/datasets/{dataset_id}/feedback","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source","dataset_id","body"],"properties":{"source":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"},"dataset_id":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."},"body":{"type":"object","description":"JSON request body"}}}}}},"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:opendatasoft/get-dataset-file":{"get":{"operationId":"open_data_opendatasoft_get_dataset_file","summary":"Download file","description":"GET /{source}/datasets/{dataset_id}/files/{file_id}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"file_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"thumbnail_size","in":"query","required":false,"description":"Set the size of the thumbnail representing the resource (attachment, image or file)","schema":{"type":"string","description":"Set the size of the thumbnail representing the resource (attachment, image or file)"}}],"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/open-data:opendatasoft/get-records":{"get":{"operationId":"open_data_opendatasoft_get_records","summary":"Search dataset's records.","description":"GET /{source}/datasets/{dataset_id}/records","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"group_by","in":"query","required":false,"description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…","schema":{"type":"string","description":"A group by expression defines a grouping function for an aggregation. It can be: - a field name: group result by each value of this field…"}},{"name":"sort","in":"query","required":false,"description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…","schema":{"type":"array","description":"**Deprecated, use `order_by` instead.** A list of field names, each possibly prefixed with a minus (-). Sorts results according to the…"}},{"name":"order_by","in":"query","required":false,"description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…","schema":{"type":"array","description":"A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Sorts results according to the…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/get-record":{"get":{"operationId":"open_data_opendatasoft_get_record","summary":"Retrieve a single record based on its ID.","description":"GET /{source}/datasets/{dataset_id}/records/{record_id}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"record_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"select","in":"query","required":false,"description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…","schema":{"type":"string","description":"A select expression can be used to add, remove or change fields to return. An expression can be: - a wildcard ('*'): return all fields - a…"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/get-dataset-reuses":{"get":{"operationId":"open_data_opendatasoft_get_dataset_reuses","summary":"Get list of reuses","description":"GET /{source}/datasets/{dataset_id}/reuses","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/get-dataset-reuse":{"get":{"operationId":"open_data_opendatasoft_get_dataset_reuse","summary":"Retrieve a single reuse based on its ID.","description":"GET /{source}/datasets/{dataset_id}/reuses/{reuse_id}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"reuse_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/get-dataset-snapshots":{"get":{"operationId":"open_data_opendatasoft_get_dataset_snapshots","summary":"List of all snapshots for this dataset.","description":"GET /{source}/datasets/{dataset_id}/snapshots","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/download-dataset-snapshot":{"get":{"operationId":"open_data_opendatasoft_download_dataset_snapshot","summary":"List of all snapshots for this dataset.","description":"GET /{source}/datasets/{dataset_id}/snapshots/{snapshot_id}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"dataset_id","in":"query","required":true,"description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page.","schema":{"type":"string","description":"Dataset identifier. Can be found in the \"information\" tab of the dataset page."}},{"name":"snapshot_id","in":"query","required":true,"schema":{"type":"string"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/export-datasets-csv":{"get":{"operationId":"open_data_opendatasoft_export_datasets_csv","summary":"Export catalog (source) in CSV format","description":"GET /{source}/exports/csv","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}},{"name":"delimiter","in":"query","required":false,"description":"Provide a different delimiter (default ',').","schema":{"type":"string","enum":[",",";","|"],"default":";","description":"Provide a different delimiter (default ',')."}}],"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/open-data:opendatasoft/export-datasets-json":{"get":{"operationId":"open_data_opendatasoft_export_datasets_json","summary":"Export catalog (source) in JSON format","description":"GET /{source}/exports/json","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"pretty","in":"query","required":false,"description":"Activate pretty print","schema":{"type":"boolean","default":false,"description":"Activate pretty print"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/export-datasets-rdf":{"get":{"operationId":"open_data_opendatasoft_export_datasets_rdf","summary":"Export catalog (source) in RDF/XML format","description":"GET /{source}/exports/rdf","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/export-datasets-rss":{"get":{"operationId":"open_data_opendatasoft_export_datasets_rss","summary":"Export catalog (source) in RSS format","description":"GET /{source}/exports/rss","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/export-datasets-ttl":{"get":{"operationId":"open_data_opendatasoft_export_datasets_ttl","summary":"Export catalog (source) in TTL (turtle/rdf) format","description":"GET /{source}/exports/ttl","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/export-datasets-xls":{"get":{"operationId":"open_data_opendatasoft_export_datasets_xls","summary":"Export catalog (source) in XLS (Excel) format","description":"GET /{source}/exports/xls","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"limit","in":"query","required":false,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…","schema":{"type":"integer","default":10,"description":"Number of items to return. To use in conjonction with offset to implement pagination. Limit maximum value is 100. To retrive more data use…"}},{"name":"offset","in":"query","required":false,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination.","schema":{"type":"integer","default":0,"description":"Index of the first item to return (starting at 0). To use in conjonction with limit to implement pagination."}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}},{"name":"include_app_metas","in":"query","required":false,"description":"Explicitely request application metas for each datasets.","schema":{"type":"boolean","default":false,"description":"Explicitely request application metas for each datasets."}}],"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/open-data:opendatasoft/get-datasets-facets":{"get":{"operationId":"open_data_opendatasoft_get_datasets_facets","summary":"Enumerate facets values for datasets and return a list of values for each facet. Can be used to implement…","description":"GET /{source}/facets","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"facet","in":"query","required":false,"description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…","schema":{"type":"array","description":"A facet is a field used for simple filtering (through the parameters refine and exclude) or exploration (with the endpoint `/facets`).…"}},{"name":"refine","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will only include the selected facet value.…"}},{"name":"exclude","in":"query","required":false,"description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…","schema":{"type":"array","description":"An array of facet filters. For example **city:Paris** or **modified:2019/12**. The request will exclude the defined facet value. Read…"}},{"name":"where","in":"query","required":false,"description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…","schema":{"type":"array","description":"An array of filters. A filter is a text expression performing a simple full-text search that can also include logical operations (NOT,…"}},{"name":"search","in":"query","required":false,"description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…","schema":{"type":"array","description":"An array of full text search. A full text search performs a prefixed text search for each provided terms in all visible fields of a…"}},{"name":"timezone","in":"query","required":false,"description":"Set timezone for datetime fields","schema":{"type":"string","default":"UTC","description":"Set timezone for datetime fields"}}],"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/open-data:opendatasoft/get-metadata-templates-types":{"get":{"operationId":"open_data_opendatasoft_get_metadata_templates_types","summary":"List of available metadata templates types, each with their endpoints.","description":"GET /{source}/metadata_templates","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}}],"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/open-data:opendatasoft/get-metadata-templates-type":{"get":{"operationId":"open_data_opendatasoft_get_metadata_templates_type","summary":"List of metadata templates available for this type.","description":"GET /{source}/metadata_templates/{metadata_template_type}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"metadata_template_type","in":"query","required":true,"schema":{"type":"string","enum":["basic","interop","extra"],"default":"basic"}}],"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/open-data:opendatasoft/get-metadata-template":{"get":{"operationId":"open_data_opendatasoft_get_metadata_template","summary":"A single metadata_template","description":"GET /{source}/metadata_templates/{metadata_template_type}/{metadata_template_name}","tags":["open-data"],"parameters":[{"name":"source","in":"query","required":true,"description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…","schema":{"type":"string","enum":["catalog","opendatasoft","monitoring"],"default":"catalog","description":"Each source represents a different catalog of datasets you'll be able to query. There are 2 sources available: * catalog: the catalog of…"}},{"name":"metadata_template_type","in":"query","required":true,"schema":{"type":"string","enum":["basic","interop","extra"],"default":"basic"}},{"name":"metadata_template_name","in":"query","required":true,"schema":{"type":"string"}}],"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"}}}}}}}