Profile activity - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service responds with the number of generative AI queries grouped by profile.

Method Endpoint
POST 
/analytics/api/v1/genai/profile-activity

The use of Generative AI is a premium feature and requires a subscription. Get in touch with a Fluid Topics representative for more information.

Request example

The following lines show an example of a JSON request body:

{
  "startDate": "2024-05-01",
  "endDate": "2024-08-01",
  "groupByPeriod": "month",
  "filters": {
    "profile": [
      "7fbae8e0756f-9131-4b44-a66b-dce7c587",
      "7fe07756f-9131-548d-a66b-dce8574"
    ]
  }
}
Field Type Required? Description
startDate String Yes The inclusive start date of the period. The start date must be in the past year.
endDate String Yes The exclusive end date of the period. The end date must be later than the start date.
groupByPeriod String Yes The period by which to group the generative AI queries. Valid values are month, week and day.
filters Array No Allows the filtering of results by profile ID.
profile Array No A list of one or more profiles.

Response body

{
  "startDate": "2024-05-01",
  "endDate": "2024-08-01",
  "results": [
    {
      "id": "7fbae8e0756f-9131-4b44-a66b-dce7c587",
      "name": "MyProfile1",
      "periods": [
        {
          "periodStartDate": "2024-05-01",
          "periodEndDate": "2024-06-01",
          "genaiQueryCount": 1545
        },
        {
          "periodStartDate": "2024-06-01",
          "periodEndDate": "2024-07-01",
          "genaiQueryCount": 1200
        },
        {
          "periodStartDate": "2024-07-01",
          "periodEndDate": "2024-08-01",
          "genaiQueryCount": 1347
        }
      ]
    },
    {
      "id": "7fe07756f-9131-548d-a66b-dce8574",
      "name": "MyProfile2",
      "periods": [
        {
          "periodStartDate": "2024-05-01",
          "periodEndDate": "2024-06-01",
          "genaiQueryCount": 124
        },
        {
          "periodStartDate": "2024-06-01",
          "periodEndDate": "2024-07-01",
          "genaiQueryCount": 14
        },
        {
          "periodStartDate": "2024-07-01",
          "periodEndDate": "2024-08-01",
          "genaiQueryCount": 3458
        }
      ]
    }
  ]
}

The Profile activity web service does not take into account generative AI queries from the Design menus, or when using the Test connection button.

Field Type Description
startDate String The inclusive start date of the period. The start date must be in the past year.
endDate String The exclusive end date of the period. The end date must be later than the start date.
results Array An array containing the results.
periodStart String The inclusive start date of the period by which results are grouped.
periodEnd String The exclusive end date of the period by which results are grouped.
genaiQueryCount Number The number of genAI queries for the profile and the period.
Return code Description
200 OK Returns results.