Huwise Explore API

https://help.opendatasoft.com/apis/ods-explore-v2/
Admin
Huwise Explore API is a REST API that provides hierarchical access to datasets with support for the...
Tokens:57,509
Snippets:354
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### range() group by static ranges examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of using the range() grouping function in a group_by clause to create static ranges. The examples show numerical and date ranges, including the use of '*' for infinity. Note that the lower bound is included and the higher bound is excluded.

```sql
RANGE(population, *, 10, 50, 100, *)               -- Creates 4 groups: [*, 9], [10, 49], [50, 99] and [100, *]
RANGE(population, 20.5, *)                         -- Creates 1 group: [20.5, *[
RANGE(population, 1,2,3)                           -- Creates 2 groups: [1-1], [2, 2]
RANGE(date, *, date'2020-11-13', date'2021-01-01') -- Creates 2 groups: [*, 2020-11-13T00:00:00.000Z[ and [2020-11-13T00:00:00.000Z, 2021-01-01T00:00:00.000Z[
```

--------------------------------

### GET /catalog/datasets/{dataset_id}/records - 200 Response Example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example JSON response for a successful 200 request to the records endpoint. Shows a total_count of 137611 and a results array with two records, each containing fields like admin1_code, name, coordinates, and timezone.

```json
{
  "total_count": 137611,
  "results": [
    {
      "admin1_code": "27",
      "elevation": null,
      "name": "Saint-Leu",
      "modification_date": "2019-03-26",
      "alternate_names": [
        "Saint-Leu"
      ],
      "feature_class": "P",
      "admin3_code": "711",
      "cou_name_en": "France",
      "coordinates": {
        "lat": 46.7306,
        "lon": 4.50083
      },
      "country_code_2": null,
      "geoname_id": "2978771",
      "feature_code": "PPL",
      "label_en": "France",
      "dem": 366,
      "country_code": "FR",
      "ascii_name": "Saint-Leu",
      "timezone": "Europe/Paris",
      "admin2_code": "71",
      "admin4_code": "71436",
      "population": 29278
    },
    {
      "admin1_code": "32",
      "elevation": null,
      "name": "Saint-Léger-lès-Domart",
      "modification_date": "2016-02-18",
      "alternate_names": [
        "Saint-Leger",
        "Saint-Leger-les-Domart",
        "Saint-Léger",
        "Saint-Léger-lès-Domart"
      ],
      "feature_class": "P",
      "admin3_code": "802",
      "cou_name_en": "France",
      "coordinates": {
        "lat": 50.05208,
        "lon": 2.14067
      },
      "country_code_2": null,
      "geoname_id": "2978817",
      "feature_code": "PPL",
      "label_en": "France",
      "dem": 31,
      "country_code": "FR",
      "ascii_name": "Saint-Leger-les-Domart",
      "timezone": "Europe/Paris",
      "admin2_code": "80",
      "admin4_code": "80706",
      "population": 1781
    }
  ]
}
```

--------------------------------

### GET /oauth2/authorize/ request

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example HTTP request to the /oauth2/authorize/ endpoint with query parameters client_id, redirect_uri, response_type, state, and scope.

```http
GET /oauth2/authorize/?
client_id=123456789&
redirect_uri=https://example.com&
response_type=code&
state=ilovedata&
scope=all HTTP/1.1
```

--------------------------------

### include() and exclude() function examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Demonstrates the include() and exclude() pseudo-functions for filtering fields. The examples show exact field name matching and wildcard suffix matching with 'pop*'.

```sql
include(pop) -- will only include fields which name is pop

exclude(pop) -- will exclude fields which name is pop

include(pop*) -- Will include fields beginning with pop
```

--------------------------------

### suggest() function examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of the suggest() ODSQL predicate. It performs a case-insensitive prefix search on the specified fields. Note that it may miss some results when used with small prefixes.

```sql
suggest(*, "film")  -- returns results that contain film, films, filmography, etc. in at least one visible field
suggest("film")  -- equivalent to the above query
search(title, "secret")  -- will match "THE BOOK OF SECRETS"

suggest(text_field, other_text_field, "film")  -- same search but in text_field or other_text_field
suggest(text_field, "film") OR suggest(other_text_field, "film") -- equivalent to the above query

suggest(text_field, "film") AND suggest(other_text_field, "film") -- returns results that contain film, films, filmography, etc. in both fields
```

--------------------------------

### count() aggregation examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of the count() function. The first counts all elements, the second counts non-null values of the population field with an alias.

```sql
count(*) -- Return number of elements

count(population) as population_count_not_empty -- Return number of elements where `population` field is not empty
```

--------------------------------

### Order by random() examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of using the random() function in the order_by clause. The same seed returns the same random order; different seeds produce different orders.

```sql
group_by=city & order_by=random(1) -- Order cities randomly

group_by=city & order_by=random(1) -- Order cities randomly in the exact same order as the first example

group_by=city & order_by=random(2) -- Order cities randomly in a different order than the first example
```

--------------------------------

### startswith() SQL examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of the startswith() function. It performs a case-sensitive prefix search on text fields. The first parameter can be a field name or '*' for all visible fields, and the last parameter is the search string.

```sql
startswith(id, "ID4536")  -- will match id that start with "ID4536"
startswith(title, "SECRET")  -- will match "SECRET DEFENSE" but not "THE BOOK OF SECRETS", nor "book of secret"
```

--------------------------------

### vector_similarity() example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of the vector_similarity() function used in the order_by clause for semantic search. The query string is passed as a literal.

```sql
vector_similarity("jazz concerts in nyc")
```

--------------------------------

### lower() function examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Shows how to use the lower() function with a literal string and a text field. The first example returns 'jazz' from 'JAZZ', and the second returns the lowercase representation of the field.

```sql
lower('JAZZ') -- returns 'jazz'

lower(text_field) -- returns the lowercase representation of the field
```

--------------------------------

### sum() aggregation example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of using the sum() aggregate function in a select clause. It sums all values of the population field and aliases the result as sum_population.

```sql
sum(population) as sum_population -- Return the sum of all values for the population field
```

--------------------------------

### ODSQL order_by examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Four examples of the order_by parameter in ODSQL queries, showing sorting by field, aggregation, label, and multiple expressions. Note that aggregations must come before fields in the order_by list.

```sql
group_by=city & order_by=city ASC -- Order cities alphabetically
```

```sql
group_by=city & order_by=count(*) DESC -- Order each city by its number of records
```

```sql
select=count(*) as population_count & group_by=city  & order_by=population_count DESC -- Order each city by its number of records, using a label
```

```sql
group_by=city, year(birth_date) as birth_year & order_by=city DESC, birth_year ASC -- Order by city and then by year of birth
```

--------------------------------

### Aggregation expression examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of aggregation expressions: SUM(population) with alias and COUNT(*).

```sql
SUM(population) as sum_population -- Will compute the sum of all values for the field `population` returned as sum_population

COUNT(*) -- Return number of elements
```

--------------------------------

### Search query filter examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of search queries using quoted strings and boolean operators. These perform full-text searches on all visible fields.

```sql
"tree"

"tree" AND "flower"

"tree" OR "car"

NOT "dog"

"dog" AND NOT "cat"
```

--------------------------------

### now() function examples with named parameters

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of the now() function with various named parameters, assuming current date time is 2021-05-06 12:34:55.450500+00:00 (a Thursday). Shows how to set or modify date/time components, including handling of invalid dates and weekday adjustments.

```sql
now() -- Returns '2021-05-06T12:34:55.450500+00:00'
now(year=2000) -- Sets the year component to return '2000-05-06T12:34:55.450500+00:00'
now(years=-1) -- Sets the year to one year ago which is '2020-05-06T12:34:55.450500+00:00'
now(year=2001, months=-1) -- Sets the year to 2001 and subtract 1 month to return '2000-04-06T12:34:55.450500+00:00'
now(day=31,month=2) -- Sets the day to 31, then the month to 2. The actual day part is rounded to 28 '2021-02-28T12:34:55.450500+00:00'
now(weekday=0) -- Sets the day to the next Monday which is '2021-05-10T12:34:55.450500+00:00'
now(mondays=+1) -- Sets the day to the next Monday which is also '2021-05-10T12:34:55.450500+00:00'
now(mondays=-1) -- Sets the day to the previous Monday which is '2021-05-03T12:34:55.450500+00:00'
```

--------------------------------

### Select field literal examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of select field literals: selecting all fields with *, selecting specific fields, and renaming a field with AS.

```sql
*                           -- Select all fields

field1, field2, field3      -- Only select field1, field2, and field3

field1 AS my_field, field2  -- Renaming field1 as my_field and select field2
```

--------------------------------

### search() predicate example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of the search() predicate used in the where clause. It performs a fuzzy and prefix search on the title field, matching 'THE BOOK OF SECRETS'.

```sql
search(title, "bok of secret")  -- will match "THE BOOK OF SECRETS"
```

--------------------------------

### avg() aggregation example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of an avg aggregation. Returns the average of the population field over a group. Can be used in select and order_by clauses.

```sql
avg(population) as avg_population -- Return the average of the population
```

--------------------------------

### Multiple group by expressions with label

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of multiple group by expressions with a label using the `group_by` parameter.

```sql
group_by=my_field1,my_field2 as my_field
```

--------------------------------

### Arithmetic expressions examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of arithmetic expressions in ODSQL. Note that division by zero returns null and operators are only defined on numeric values.

```sql
2 * population -- the value of the field `population` doubled

"hello" -- the constant string "hello"

length(country_name) -- the string length of the field `country_name`
```

--------------------------------

### Boolean operator examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Two examples showing boolean operator precedence. The first uses AND and OR without parentheses, the second uses parentheses to change precedence. Comments explain the expected results.

```sql
my_boolean_field OR my_numeric_field > 50 and my_date_field > date'1972'
-- Results can have my_boolean_field to true. They can also have my_numeric_field greater than 50 and my_date_field older than 1972

(my_boolean_field OR my_numeric_field > 50) and my_date_field > date'1972'
-- Results must have my_date_field older than 1972. They also must have my_boolean_field to true or my_numeric_field greater than 50
```

--------------------------------

### vector_similarity_threshold() SQL examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Two SQL examples showing how to use the vector_similarity_threshold() function in a WHERE clause for semantic search. The first searches for 'quentin tarantino movies' and may return results about films, movie directors, etc. The second searches for 'content about music & jazz' and can return results in other languages depending on the portal.

```sql
-- can return results that contain film, movie, pulp fiction, filmography,
-- or content about other movie directors.
vector_similarity_threshold("quentin tarantino movies")

-- can also return results in another language, for instance in French or German depending on the portal.
vector_similarity_threshold("content about music & jazz")
```

--------------------------------

### Simple group by field expression

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of a simple group by field expression using the `group_by` parameter.

```sql
group_by=my_field
```

--------------------------------

### count(distinct) aggregation examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of the count(distinct) function. The first counts unique values of the species field, the second counts unique values while treating nulls as 'unknown'.

```sql
count(distinct species) -- Return the number of unique values for the field species

count(distinct ifnull(species, "'unknown'")) -- Same as above, but null values will be counted as equals to 'unknown'
```

--------------------------------

### GET /catalog/datasets/{dataset_id}/exports/{format}

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Exports a dataset in the desired format. The `group_by` parameter is only available on exports starting with v2.1.

```APIDOC
## GET /catalog/datasets/{dataset_id}/exports/{format}

### Description
Export a dataset in the desired format. Note: The `group_by` parameter is only available on exports starting with the v2.1.

### Method
GET

### Endpoint
/catalog/datasets/{dataset_id}/exports/{format}

### Parameters
#### Path Parameters
- **dataset_id** (string) - Required - The identifier of the dataset to be queried. You can find it in the "Information" tab of the dataset page or in the dataset URL, right after `/datasets/`.
- **format** (string) - Required - The export format. Enum: "csv", "fgb", "geojson", "gpx", "json", "jsonl", "jsonld", "kml", "n3", "ov2", "parquet", "rdfxml", "shp", "turtle", "xlsx".

#### Query Parameters
- **select** (string) - Optional - A select expression can be used to add, remove or change the fields to return. An expression can be: a wildcard ('*'), a field name, an include/exclude function, or a complex expression with a label.
- **where** (string) - Optional - A `where` filter is a text expression performing a simple full-text search that can also include logical operations (NOT, AND, OR...) and lots of other functions to perform complex and precise search operations. See ODSQL reference documentation.
- **order_by** (string) - Optional - A comma-separated list of field names or aggregations to sort on, followed by an order (`asc` or `desc`). Results are sorted in ascending order by default.
- **group_by** (string) - Optional - A group by expression defines a grouping function for an aggregation. It can be a field name, a range function, or a date function. It is possible to specify a custom name with the 'as name' notation.
- **limit** (integer) - Optional - Number of items to return in export. Use -1 (default) to retrieve all records. Default: -1. Minimum: -1.
- **refine** (string) - Optional - A facet filter used to limit the result set. Syntax: `refine=<FACETNAME>:<FACETVALUE>`. For date and other hierarchical facets, refining on one value will show related second-level values.
- **exclude** (string) - Optional - (Details not provided in source)

### Authorizations
- apikey

### Responses
#### Success Response (200)
The exported dataset in the requested format.

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **429** - Too many requests
- **500** - Internal Server Error
```

--------------------------------

### GET /catalog/facets

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Enumerates facet values for datasets and returns a list of values for each facet. Can be used to implement guided navigation in large result sets.

```APIDOC
## GET /catalog/facets

### Description
Enumerate facet values for datasets and returns a list of values for each facet. Can be used to implement guided navigation in large result sets.

### Method
GET

### Endpoint
/catalog/facets

### Parameters
#### Query Parameters
- **facet** (string) - Optional - A facet is a field used for simple filtering (through the `refine` and `exclude` parameters) or exploration (with the `/facets` endpoint). It can also be a function such as `facet=facet(name="field_name")` which is identical to `facet=field_name`. But this `facet()` function can also take some optional arguments such as `disjunctive`, `hierarchical`, `separator`, `sort` and `limit`.
- **refine** (string) - Optional - Example: `refine=modified:2020` - Return only the value `2020` from the `modified` facet. A facet filter used to limit the result set. Using this parameter, you can refine your query to display only the selected facet value in the response. Refinement uses the following syntax: `refine=<FACETNAME>:<FACETVALUE>`.
- **exclude** (string) - Optional - Examples: `exclude=city:Paris` - Exclude the value `Paris` from the `city` facet. Facets enumeration will display `Paris` as `excluded` without any count information. A facet filter used to exclude a facet value from the result set. Using this parameter, you can filter your query to exclude the selected facet value in the response. `exclude` uses the following syntax: `exclude=<FACETNAME>:<FACETVALUE>`.
- **where** (string) - Optional - A `where` filter is a text expression performing a simple full-text search that can also include logical operations (NOT, AND, OR...) and lots of other functions to perform complex and precise search operations.
- **timezone** (string) - Optional - Default: "UTC". Examples: timezone=UTC, timezone=Europe/Paris, timezone=US/Eastern, timezone=Europe/London, timezone=Europe/Berlin. Set the timezone for datetime fields.

### Response
#### Success Response (200)
An enumeration of facets

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **429** - Too many requests
- **500** - Internal Server Error

### Authorizations
_apikey_

### Example URL
https://documentation-resources.huwise.com/api/explore/v2.1/catalog/facets
```

--------------------------------

### GET /catalog/datasets/{dataset_id}/facets

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Enumerates facet values for records and returns a list of values for each facet. Can be used to implement guided navigation in large result sets.

```APIDOC
## GET /catalog/datasets/{dataset_id}/facets

### Description
Enumerates facet values for records and returns a list of values for each facet. Can be used to implement guided navigation in large result sets.

### Method
GET

### Endpoint
/catalog/datasets/{dataset_id}/facets

### Parameters
#### Path Parameters
- **dataset_id** (string) - Required - The identifier of the dataset to be queried. You can find it in the "Information" tab of the dataset page or in the dataset URL, right after `/datasets/`.

#### Query Parameters
- **where** (string) - Optional - A `where` filter is a text expression performing a simple full-text search that can also include logical operations (NOT, AND, OR...) and lots of other functions to perform complex and precise search operations. For more information, see [Opendatasoft Query Language (ODSQL)](https://help.opendatasoft.com/apis/ods-explore-v2/#section/Opendatasoft-Query-Language-(ODSQL)/Where-clause) reference documentation.
- **refine** (string) - Optional - Example: `refine=modified:2020` - Return only the value `2020` from the `modified` facet. A facet filter used to limit the result set. Using this parameter, you can refine your query to display only the selected facet value in the response. Refinement uses the following syntax: `refine=<FACETNAME>:<FACETVALUE>`. For date, and other hierarchical facets, when refining on one value, all second-level values related to that entry will appear in facets enumeration. For example, after refining on the year 2019, the related second-level month will appear. And when refining on August 2019, the third-level day will appear. **`refine` must not be confused with a `where` filter. Refining with a facet is equivalent to selecting an entry in the left navigation panel.**
- **exclude** (string) - Optional - Examples: `exclude=city:Paris` - Exclude the value `Paris` from the `city` facet. Facets enumeration will display `Paris` as `excluded` without any count information. `exclude=modified:2019/12` - Exclude the value `2019/12` from the `modified` facet. Facets enumeration will display `2020` as `excluded` without any count information. A facet filter used to exclude a facet value from the result set. Using this parameter, you can filter your query to exclude the selected facet value in the response. `exclude` uses the following syntax: `exclude=<FACETNAME>:<FACETVALUE>`. **`exclude` must not be confused with a `where` filter. Excluding a facet value is equivalent to removing an entry in the left navigation panel.**
- **facet** (string) - Optional - A facet is a field used for simple filtering (through the `refine` and `exclude` parameters) or exploration (with the `/facets` endpoint). It can also be a function such as `facet=facet(name="field_name")` which is identical to `facet=field_name`. But this `facet()` function can also take some optional arguments such as `disjunctive`, `hierarchical`, `separator`, `sort` and `limit`. `disjunctive`: a boolean `true/false`, whether multiple values can be selected for the facet. `hierarchical`: a boolean `true/false` if the field is hierarchical. The separator must be given as the argument. For instance, you can do `facet=facet(name="filepath", hierarchical=true, separator="/")` to retrieve facets related to this field which might look like `"/home/user/file.txt"`. `separator`: a string, e.g. `/`, `-`, `;`. `sort`: a string which describes how to sort the facets. Possible arguments are `count` and `-count` for all field types, `alphanum` and `-alphanum` for `date`, `datetime` and `text`, `num` and `-num` for `decimal` and `int`. `limit`: an integer to limit the number of results.
- **lang** (string) - Optional - Enum: "en" "fr" "nl" "pt" "it" "ar" "de" "es" "ca" "eu" "sv". A language value. If specified, the `lang` value override the default language, which is "fr". The language is used to format string, for example in the `date_format` function.
- **timezone** (string) - Optional - Default: "UTC". Examples: timezone=UTC - UTC timezone, timezone=Europe/Paris - Paris timezone, timezone=US/Eastern - Eastern timezone, timezone=Europe/London - London timezone, timezone=Europe/Berlin - Berlin timezone. Set the timezone for datetime fields. Timezone IDs are defined by the [Unicode CLDR project](https://github.com/unicode-org/cldr). The list of timezone IDs is available in [timezone.xml](https://github.com/unicode-org/cldr/blob/master/common/bcp47/timezone.xml).

### Responses
#### Success Response (200)
Facets enumeration

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **429** - Too many requests
- **500** - Internal Server Error

### Example URL
https://documentation-resources.huwise.com/api/explore/v2.1/catalog/datasets/{dataset_id}/facets
```

--------------------------------

### Simple group by expression with label

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of a simple group by expression with a label using the `group_by` parameter.

```sql
group_by=my_field as myfield
```

--------------------------------

### distance() function example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Shows the syntax for the distance() function, which computes arc distance between a geo_point field and a reference point geometry. The result is in meters and can be used in select and order_by clauses.

```sql
distance(field_name, GEOM'<geometry>')
```

--------------------------------

### GET /catalog/exports/{format}

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Exports the catalog in a specified format. This endpoint returns a file in the requested format.

```APIDOC
## GET /catalog/exports/{format}

### Description
Exports the catalog in a specified format. This endpoint returns a file in the requested format.

### Method
GET

### Endpoint
/catalog/exports/{format}

### Parameters
#### Path Parameters
- **format** (string) - Required - The format of the export file.

### Response
#### Success Response (200)
Return a file

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **429** - Too many requests
- **500** - Internal Server Error

### Response Example (400)
```json
{
  "message": "ODSQL query is malformed: invalid_function() Clause(s) containing the error(s): select.",
  "error_code": "ODSQLError"
}
```

```

--------------------------------

### IN filter on multivalued field examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Filters results where the given literal is present in the multivalued field. Examples show string, integer, decimal, and boolean literals.

```sql
"Paris" IN multivalued_text_field -- Filters results such as the literal "Paris" is present in the multivalued field
15 IN multivalued_int_field -- Same as above but with an integer literal
12.087 IN mutlivalued_decimal_field -- Same as above but with a decimal literal
true IN mutlivalued_boolean_field -- Same as above but with a boolean literal
```

--------------------------------

### Field name examples in ODSQL

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Shows how field names are used in ODSQL clauses. Field names containing only numbers or reserved keywords must be enclosed in back quotes.

```sql
my_field > 10  -- my_field is a field name

`12` > 10  -- without back quotes, 12 would be considered a numeric literal

`and`: "value" -- AND is a keyword, `and` represents a field name then
```

--------------------------------

### IS NULL filter examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of null filter expressions. The first matches records where film_name is null, the second matches records where film_name is not null. Can only be used in the where clause.

```sql
film_name is null      -- matches records where film_name is null

film_name is not null  -- matches records where film_name is not null
```

--------------------------------

### GET /catalog/exports/{format}

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Exports the catalog in the desired format. The format is specified as a path parameter, and the operation requires an API key.

```APIDOC
## GET /catalog/exports/{format}

### Description
Export a catalog in the desired format.

### Method
GET

### Endpoint
/catalog/exports/{format}

### Authorizations
- apikey

### Path Parameters
- **format** (string) - Required - Format specifier for the catalog export. Enum: "csv", "data.json", "dcat", "dcat_ap_ch", "dcat_ap_de", "dcat_ap_se", "dcat_ap_sp", "dcat_ap_it", "dcat_ap_vl", "dcat_ap_benap", "dublin_core", "json", "rdf", "rss", "ttl", "xlsx". Note: `dcat_ap_*` formats are only available upon activation.

### Responses
- **200** - Successful export
- **400** - Bad Request
- **401** - Unauthorized
- **429** - Too many requests
- **500** - Internal Server Error
```

--------------------------------

### within_distance() SQL examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of the within_distance() function. It limits results to a circular geographical area defined by a center geometry and a distance with a unit (e.g., km, yd).

```sql
within_distance(field_name, GEOM'<geometry>', 1km)

within_distance(field_name, GEOM'<geometry>', 100yd)
```

--------------------------------

### geometry_type() function usage examples

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Examples of using geometry_type() to return the geometry type of a field and to filter for only Polygon records in a WHERE clause. The function works with geo_point or geo_shape fields.

```sql
-- returns the type of the geometry for this specific field
geometry_type(field)

-- in a WHERE clause allows you to filter for only records with Polygons
geometry_type(geo_field) = 'Polygon'
```

--------------------------------

### startswith()

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

The startswith() function performs a case-sensitive prefix search on selected text fields. It can be used only in the where clause and returns a boolean.

```APIDOC
## startswith()

### Description
The `startswith()` function performs a text query on all selected fields of each record and returns matching records. It is a prefix search: it matches text fields that contain strings beginning with the searched string. The matching is case sensitive.

### Syntax
`startswith(<text_field>|*, <text_literal>)`

### Parameters
- `<text_field>` (string) - Required - The set of fields on which the search is done. Use `*` or empty to search on all visible fields, or a subset of field names separated with a comma.
- `<text_literal>` (string) - Required - The string to search for.

### Clauses
- `where` only

### Returned Type
boolean

### Examples
```sql
startswith(id, "ID4536")  -- will match id that start with "ID4536"
startswith(title, "SECRET")  -- will match "SECRET DEFENSE" but not "THE BOOK OF SECRETS", nor "book of secret"
```
```

--------------------------------

### within() function example

Source: https://help.opendatasoft.com/apis/ods-explore-v2/explore_v2.1.html

Example of the `within()` ODSQL predicate used in a `where` clause. It limits results to records whose `geo_shape` field lies within the given polygon geometry literal.

```sql
within(geo_shape, geom'POLYGON((2.331161 48.869762, 2.3600006 48.87574, 2.373046875 48.85101, 2.3503875 48.84209, 2.3376846 48.85451, 2.3311614 48.869762))')
```
Tokens:
Raw