Product Selector

Fusion 5.9
    Fusion 5.9

    MetatagsSpringboard Query API

    The metatags endpoint of the Query API retrieves all the custom metadata tags associated with an application, where at least one document contains data in that metatag.

    A metatags request does not retrieve any values associated with a metatag.

    Prerequisites

    Before using this endpoint, use the Authentication API with the scope value of connectedsearch.query to generate an access token. The access token is used to authenticate your requests.

    You must also supply the APPLICATION_ID value, as the request URL requires it. To obtain the value, click the Integrations icon from the Applications UI sidebar and then click the APIs tab. The value is in the Application ID field.

    Basic metatags request

    The metatags endpoint does not require any parameters in its body.

    The following sample displays a minimal metatags cURL request.

    Replace APPLICATION_ID with your Application ID. Replace ACCESS_TOKEN with the access token you generated using the Authentication API.

    curl --request POST \
      --url https://APPLICATION_ID.applications.lucidworks.com/query/metatags \
      --header 'Authorization: Bearer ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{
    }'

    The following sample displays a metatags response from an application with two metatags, page.metatags.publishedyear and page.metatags.publisheddecade.

    {
      "queryId" : "fd110486-f168-47c0-a419-1518a4840589",
      "fields" : [ "page.metatags.publishedyear", "page.metatags.publisheddecade" ]
    }

    Analytics data

    By default, analyticsData is set to true and the request is included in analytical data. If you are testing a request and do not want it to appear in your analytical data, use "analyticsData": false.