Keyword List List – Django REST framework

Using the keyword endpoint

Here, categories for events are listed. Events in each category can be found at the event endpoint using the query parameter keyword. The common keywords used in all events originate from the general Finnish ontology (yso), hence the format yso:p4354. Default ordering is decreasing order by the number of events found.

The most common event categories are listed in the two keyword sets helsinki:topics and helsinki:audiences, which list the YSO keywords that are present in most events to specify event main topic and audience.

Keyword text

To find keywords that contain a specific string, use the query parameter text.

Example:

keyword/?text=lapset

See the result

Free text

While the previous search is looking for the keywords containg exact matches of the search string, free_text retrieves keywords on the basis of similarity. Results are sorted by similarity.

Example:

keyword/?free_text=lapppset

See the result

Keyword source

Will restrict keywords to a specific data source.

Example:

keyword/?data_source=yso

See the result

Show only keywords with the upcoming events

To show only the keywords which are used in the upcoming events supply the has_upcoming_events query parameter.

For example:

keyword/?has_upcoming_events=True

See the result

Showing all keywords

By default, only those keywords which have listed events are displayed. You may display keywords with zero n_events with the query parameter show_all_keywords.

For example:

keyword/?show_all_keywords=True

See the result

Showing deprecated keywords

By default, deprecated keywords are not displayed. You may also display deprecated keywords with the query parameter show_deprecated.

For example:

keyword/?show_deprecated=True

See the result

Ordering

Default ordering is decreasing order by the number of events found. You may also order results by name.

For example:

keyword/?sort=name

See the result

GET /v1/keyword/?format=api&page=28

HTTP 200 OK
Allow: GET, POST, HEAD, OPTIONS
Content-Type: application/json ;utf-8
Vary: Accept

{
    "meta": {
        "count": 551,
        "next": null,
        "previous": "https://linkedevents.api.test.hel.ninja/v1/keyword/?format=api&page=27"
    },
    "data": [
        {
            "id": "espoo_le:agggfz65pm",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:11.905249Z",
            "last_modified_time": "2023-12-13T11:20:11.905267Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 11,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Karvasmäki",
                "sv": "Karvasbacka",
                "en": "Karvasmäki"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz65pm/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz664e",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.262489Z",
            "last_modified_time": "2023-12-13T11:20:12.262507Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 11,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Kunnarla",
                "sv": "Gunnars",
                "en": "Kunnarla"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz664e/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz667y",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.292077Z",
            "last_modified_time": "2023-12-13T11:20:12.292102Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 11,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Röylä",
                "sv": "Rödskog",
                "en": "Röylä"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz667y/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz7asq",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.697468Z",
            "last_modified_time": "2023-12-13T11:20:12.697485Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 10,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Högnäs",
                "sv": "Högnäs",
                "en": "Högnäs"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz7asq/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz65ta",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:11.933839Z",
            "last_modified_time": "2023-12-13T11:20:11.933862Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 9,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Kuurinniitty",
                "sv": "Kurängen",
                "en": "Kuurinniitty"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz65ta/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz65wq",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:11.962441Z",
            "last_modified_time": "2023-12-13T11:20:11.962464Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 9,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Siikajärvi",
                "sv": "Siikajärvi",
                "en": "Siikajärvi"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz65wq/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz654q",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.010819Z",
            "last_modified_time": "2023-12-13T11:20:12.010859Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 9,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Ämmässuo",
                "sv": "Käringmossen",
                "en": "Ämmässuo"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz654q/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz67ta",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.446650Z",
            "last_modified_time": "2023-12-13T11:20:12.446670Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 8,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Lakisto",
                "sv": "Lakisto",
                "en": "Lakisto"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz67ta/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz7agi",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.599804Z",
            "last_modified_time": "2023-12-13T11:20:12.599822Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 8,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Sepänkylä",
                "sv": "Smedsby",
                "en": "Sepänkylä"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz7agi/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz7aia",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.613357Z",
            "last_modified_time": "2023-12-13T11:20:12.613375Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 8,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Vanhakartano",
                "sv": "Gammelgård",
                "en": "Vanhakartano"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz7aia/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        },
        {
            "id": "espoo_le:agggfz7alq",
            "has_user_editable_resources": false,
            "alt_labels": [],
            "created_time": "2023-12-13T11:20:12.641407Z",
            "last_modified_time": "2023-12-13T11:20:12.641426Z",
            "aggregate": false,
            "deprecated": false,
            "has_upcoming_events": false,
            "n_events": 8,
            "image": null,
            "data_source": "espoo_le",
            "publisher": null,
            "replaced_by": null,
            "name": {
                "fi": "Velskola",
                "sv": "Vällskog",
                "en": "Velskola"
            },
            "@id": "https://linkedevents.api.test.hel.ninja/v1/keyword/espoo_le:agggfz7alq/?format=api",
            "@context": "http://schema.org",
            "@type": "Keyword"
        }
    ]
}