Skip to main content
POST
/
triggerDSL
/
{app}
Get a template
import requests

url = "https://{FUSION_HOST.com}/api/templating/triggerDSL/{app}"

payload = {
    "context": {},
    "facets": {
        "fields": [
            {
                "domain": {
                    "additionalFilters": [{ "type": "<string>" }],
                    "excludedFiltersByName": ["<string>"]
                },
                "ensuredValues": ["<string>"],
                "field": "<string>",
                "limit": 123,
                "minCount": 123,
                "missing": True,
                "offset": 123,
                "prefix": "<string>",
                "sort": "count"
            }
        ],
        "groupFacets": True,
        "groupingMethod": "header_doc",
        "ranges": [
            {
                "domain": {
                    "additionalFilters": [{ "type": "<string>" }],
                    "excludedFiltersByName": ["<string>"]
                },
                "end": "<string>",
                "field": "<string>",
                "gap": "<string>",
                "hardEnd": True,
                "include": ["all"],
                "minCount": 123,
                "other": ["after"],
                "start": "<string>"
            }
        ]
    },
    "params": {},
    "queryDefinition": {
        "boostsByQuery": [
            {
                "boost": 123,
                "query": { "type": "<string>" },
                "type": "<string>"
            }
        ],
        "boostsByValues": [
            {
                "boosts": [
                    {
                        "boost": 123,
                        "key": "<string>"
                    }
                ],
                "field": "<string>"
            }
        ],
        "filters": [{ "type": "<string>" }],
        "groupedFilters": [{ "type": "<string>" }],
        "groupedQuery": { "type": "<string>" },
        "main": { "type": "<string>" },
        "namedFilters": [
            {
                "name": "<string>",
                "query": { "type": "<string>" }
            }
        ],
        "userQuery": "<string>"
    },
    "results": {
        "cursor": "<string>",
        "fields": ["<string>"],
        "group": {
            "field": "<string>",
            "leaderStrategy": { "type": "<string>" },
            "size": 123,
            "sort": [
                {
                    "order": "asc",
                    "query": { "type": "<string>" },
                    "type": "expression",
                    "value": "<string>"
                }
            ]
        },
        "highlight": {
            "count": 123,
            "defaultHighlight": True,
            "fields": ["<string>"],
            "length": 123,
            "post": "<string>",
            "pre": "<string>"
        },
        "includeRawResponse": True,
        "returnScore": True,
        "size": 123,
        "sort": [
            {
                "order": "asc",
                "query": { "type": "<string>" },
                "type": "expression",
                "value": "<string>"
            }
        ],
        "start": 123
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "triggered": {
    "app": "your-app-name",
    "id": "6a163bd4-5098-466c-22aa-40bf68294303",
    "name": "Item-Detail Page",
    "all": true,
    "priority": 10,
    "dirty": true,
    "templateDirty": false,
    "markedForDeletion": false,
    "type": "lan",
    "metadata": {
      "type": "landing"
    },
    "zones": [
      {
        "id": "6a092bd4-5098-466c-94aa-40bf68294303",
        "name": "Results List",
        "type": "result-list",
        "queryProfile": "fusion-query-profile-name",
        "omitFilters": false,
        "dirty": true,
        "neverPublished": true,
        "metadata": {
          "image": "image-id",
          "primary": "primary-metadata-id",
          "secondary": "_text_"
        },
        "inTemplates": [
          "e123f4bc-5e7e-46dd-9be8-71a4f73e511a, 8084969c-bd23-40f7-9acf-c68d6798bec2, 441eb3be-7de6-470a-8141-e416a15c7db1, fb148491-b39e-46d1-af33-44cd964d8ee0"
        ],
        "staging": false,
        "published": false,
        "layout": "grid"
      }
    ],
    "neverPublished": false,
    "published": true,
    "staging": true,
    "dirtyZoneIds": [
      "a3e0e22-9e6a-45h9-a2e7-5hjk72b9a3ea, 5avc1e65-162d-5b8e-92f0-6a962e0f43c5"
    ],
    "startTime": "2024-08-24T14:15:22Z",
    "endTime": "2024-08-24T14:15:22Z",
    "triggers": [
      {
        "exact": true,
        "filters": [
          {
            "inheritable": true,
            "key": "key1",
            "value": "value1"
          }
        ],
        "matchMode": "all",
        "search": "<string>",
        "urlContext": "<string>",
        "urlPath": "<string>"
      }
    ]
  }
}

Path Parameters

app
string
required

Application ID

Query Parameters

staging
boolean
default:false

This field indicates if the request is set to retrieve published or unpublished (staging) templates. The default of false retrieves published templates. If set to true, the request retrieves unpublished (staging) templates.

templateTypes
string[]

Comma-separated list of template types, indicating which possible types of templates to trigger (e.g. landing, item-detail...)

Body

application/json

DSL request

context
object
facets
Facets · object
params
object
queryDefinition
QueryDefinition · object
results
Results · object

Response

OK

triggered
templateWithZones · object

Ordered list of zones with associated trigger criteria.