Term Matches

GET /wordlift/v1/term-matches

Changed on

Returns a list of term matches for a given taxonomy.

Request

Query parameters

Name of the taxonomy to retrieve term matches for.

cursorstring

Cursor for pagination.

limitnumber

Limit

has_matchboolean

Has match

term_containsstring

Filter by terms that contain the provided value

sort'+term_name' | '-term_name' | '+entity_name' | '-entity_name' | '+ingredient_term' | '-ingredient_term' | '+matched_ingredient' | '-matched_ingredient' | '+occurrences' | '-occurrences'

Response

OK

selfstring

The URL of the current page.

firststring

The URL of the first page.

prevstring

The URL of the previous page.

nextstring

The URL of the next page.

laststring

The URL of the last page.

Changes

    • breaking

      added the new required query request parameter taxonomies

    • warning

      deleted the query request parameter taxonomy

    • info

      added the new optional query request parameter term_contains

    • info

      added the new enum value +entity_name to the query request parameter sort

    • info

      added the new enum value +term_name to the query request parameter sort

    • info

      added the new enum value -entity_name to the query request parameter sort

    • info

      added the new enum value -term_name to the query request parameter sort

    • breaking

      the // response's property type changed from object to string for status

    • info

      added the new optional query request parameter sort