Create content analytics query endpoint that doesn't require map

[john-thomas-dotcms]

Parent Issue

No response

User Story

As a developer, I want to be able to easily perform content analytics queries via API, without having to build a JSON structure or map.

Currently, for content analytics, we support both the native CubeJS query format, and a simpler query format which places each query attribute into a single map. The map simply combines multiple query attributes into a single structure; but it requires the developer to create that structure, rather than allowing them to just submit those attributes separately.

We will create an API endpoint that allows passing each of the query attributes as a separate parameter. This will allow developers to get the analytics query results with a single API call, without the need to build a separate structure to pass into the query (e.g. a standard POST body will work, rather than a more complex nested structure).

The query attributes this endpoint must support match those currently supported in the simple query map. This includes:

1. Measurables
2. Dimensions
3. Time Dimensions
4. Filter
5. Order

So, the endpoint should take 5 parameters (one for each of the above attributes).

Details:

• Each of the params takes a string.
  • The format of most of these strings should be identical to the format of the strings required by the velocity analytics query method.
• The only params that are required are 1 and 2 (Measurables and Dimensions).
  • The others are all optional.
  • Users must be able to supply any one of the optional parameters without having to provide any other optional params.
    • If necessary, this can be handled by passing in empty strings for unused parameters.

Acceptance Criteria

1. A new API endpoint exists to submit an analytics query without using a map.
2. The endpoint supports the following query attributes - each as a separate parameter to the endpoint.
   1. Measurables (required)
   2. Dimensions (required)
   3. Time Dimensions (optional)
      • If not supplied, defaults to "Last week"
   4. Filter (optional)
      • If not supplied, no filter is used
   5. Order (optional)
      • If not supplied, sorts by the first Measurable, descending
3. Each of the params takes a string.
   • No params use or require double quotes anywhere in the strings.
4. Users can supply any one or two of the optional parameters without having to provide the other optional param(s).
5. The result format of the endpoint is identical to the result format of the current query endpoint (the one that requires a map).

Proposed Objective

Technical User Experience

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

[github-actions]

PRs:

• feat(content analytics) fixes #30521 : Allow users to pass down simple Strings to query for Content Analytics data #30811
• feat(content analytics) fixes #30521 : Allow users to pass down simple Strings to query for Content Analytics data #30847
• feat(content analytics) fixes #30521 : Allow users to pass down simple Strings to query for Content Analytics data #30869
• feat(content analytics) fixes #30521 : Allow users to pass down simple Strings to query for Content Analytics data #30899

[victoralfaro-dotcms]

Tested in dotcms/dotcms:trunk_fc6ec2a

After set a local analytics infrastructure and set a DOT_FEATURE_FLAG_CONTENT_ANALYTICS env-var to true I've navigated through http://localhost:8080 site to generate CA data.

I ran the following command to get data:

curl --location 'http://localhost:8080/api/v1/analytics/content' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--header 'Cookie: JSESSIONID=42863DA6475D1E0BC673F4BF328BFFE5' \
--data '{
    "measures": "count,totalSessions",
    "dimensions": "host,whatAmI,url",
    "filters": "totalRequest gt 0,whatAmI contains PAGE||FILE",
    "order": "count asc,createdAt asc",
    "limit": 20,
    "offset": 0
}'

And this is what I get:

{
    "entity": [
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/e7ceee89-3cc5-4e35-9795-5927ac88ad89/image/w/370/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/68434398-fa40-410a-89ac-3fad66f28630/image/280h/50q/k2-mens-mindbender-99ti-skis-1.jpeg",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/37a75e1d-916d-4820-a00a-72bf64625fc1/image/280h/50q/Gyde Calor Heated Mens Vest 1.png",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/de22b173-edc0-42f0-845f-e579903924f6/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/37a75e1d-916d-4820-a00a-72bf64625fc1/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/activities/sport-fishing",
            "request.whatAmI": "PAGE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/f1d378c9-b784-45d0-a43c-9790af678f13/image/w/370/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/53733761-4836-4dca-8787-81660feeee58/image/50q/1200w/footer-image.jpg",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/df26d95c-4f1f-4503-ac81-8176bb1c417d/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/cfef69fa-de38-4105-9cc9-a30f3e6724d7/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/09841761-aea5-4a1c-a3f3-21e0bc9f7124/image/130h/130ch/130cw/80q/13ro/wetsuit-1.jpg",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/7f2f6de7-554a-4f56-b3f3-c09c0a09b610/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/activities/snowmobiling",
            "request.whatAmI": "PAGE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/5e1076ad-e335-4a29-a956-f0094f8455d2/image/460h/460ch/460cw/80q/13ro/hiking-stick-1.jpeg",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/activities/surfing",
            "request.whatAmI": "PAGE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/654cc765-50be-4ce9-af0d-3748862f8edc/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/4e293f1c-c55e-417a-b5ae-2a09c27dc360/image1/189h/50q/",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/cbd042ff-1225-4cd9-8c6b-eed027f6289d/image/460h/460ch/460cw/80q/13ro/dress-sweater.jpg",
            "request.whatAmI": "FILE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/store/products/black-diamond-trail-pro-shock-trekking-poles",
            "request.whatAmI": "PAGE"
        },
        {
            "request.count": "1",
            "request.host": "",
            "request.totalSessions": "1",
            "request.url": "/dA/0f14f82b-b225-4213-99dc-cad27227533f/image1/189h/50q/",
            "request.whatAmI": "FILE"
        }
    ],
    "errors": [],
    "i18nMessagesMap": {},
    "messages": [],
    "pagination": null,
    "permissions": []
}