Fluid Topics calling app - Fluid Topics - Latest

Fluid Topics API Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

When calling a Fluid Topics web service, it is necessary to provide an Ft-Calling-App value. Indeed, the Fluid Topics Analytics engine relies on the Ft-Calling-App parameter to calculate API calls.

The Ft-Calling-App value is a string that identifies a use case. Use consistent, descriptive names to distinguish between different integrations and usage types. This makes it easier to interpret data in the API calls Analytics dashboard.

To set Ft-Calling-App:

  • For POST, PUT, and DELETE calls, set Ft-Calling-App as an HTTP header. In the following example, replace Your-Calling-App with an identifiable name for the use case. For example:

    curl --location 'https://docs.fluidtopics.com/api/khub/maps/search' \
        --header 'Content-Type: application/json' \
        --header 'Ft-Calling-App: Your-Calling-App' \
        --data '{
            "metadataFilters": [
                {
                    "key": "Category",
                    "valueFilter": {
                        "values": ["Reference Guides"]
                    }
                }
            ]
        }'
    
  • For GET calls, set Ft-Calling-App as a query parameter. In the following example, replace Your-Calling-App with an identifiable name for the use case. For example:

    https://docs.fluidtopics.com/api/khub/maps?Ft-Calling-App=Your-Calling-App
    

Without Ft-Calling-App value it is not possible to correctly keep track of all API calls in the Analytics.