API: Filter properties - event types for analytics

Heyhey,

for the analytics endpoint POST /analytics/query there are filters. These filters accept properties. Is there somewhere a list of these properties?

{
    "collection": "post",
    "type": "count",
    "filters": [
        {
            "prop": "type",
            "op": "eq",
            "val": "discussion_add"
        }    ],
    "interval": "monthly",
    "start": "2023-01-01T00:00:00",
    "end": "2024-12-31T00:00:00"
}

By the analytics dashboards I could determine the following labels but I was failing in retrieving the right tokens to use in the API for prop:

Category ID

Category Name

Parent Category ID (Level 1)

Type

Parent Category Name (Level 1)

Parent Category ID (Level 2)

Parent Category Name (Level 2)

Comment Name

Comment ID

Comment URL

First Comment?

Time

Discussion Comment Count

Date Added

Discussion Name

Comment Discussion Type

Post Start Date

Discussion ID

Discussion Type

Discussion Author Name

Discussion Author Rank

Discussion Author Role Type

Discussion Author Role Names

Discussion Author Role IDs

Discussion Author ID

Discussion Author UUID

Country

Country Code

User Name

User Rank

User Role Type

User Role Name

User Role ID

User Session ID

User ID

User UUID

Same question also for the related val of the prop - for normal strings and IDs its pretty clear, but for example all the type properties.

For example: I see there must be a discussion_add for the type prop

Can you please provide me a list of filter properties to be used with the analytics API or point me to the article with this information (I coulnd find one :( )

Ideally this is added in the API documention in here: https://success.vanillaforums.com/kb/articles/202-api-v2-reference-endpoints#/analytics/post_analytics_query

All the best,

Florian

Find more posts tagged with

API

Analytics

Accepted answers

paddykelly

It turns out there is a way to get properties. We have the Analytics Catalog endpoint. And in particular the /analytics/catalog/data-sources/{key} endpoint where you just add the collection (in this case, post) to the query and you will get back the structure of the data source, including its properties. For example: api/v2/analytics/catalog/data-source/post returns:

  "properties": {
    "type": {
      "name": "Type",
      "type": "string",
      "enum": [
        "comment_add",
        "discussion_add",
        "comment_delete",
        "comment_edit",
        "comment_split",
        "discussion_close",
        "discussion_delete",
        "discussion_edit",
        "discussion_merge",
        "discussion_move"
      ]
    }

All comments

paddykelly

I can't completely answer your questions, but I will try to be a bit helpful.

I'm pretty sure the reason there is no list in the filter properties of the API documentation is that those properties do not "belong" to that API's schema. They are properties that could be put into the record from many other sources. Discussions could have one limited set of properties and Reactions could have another.

Another reason is that their is not a lot of different meaningful actions being performed on Discussions (from the perspective of Analytics). These are the properties I have found:

"discussion_add", "discussion_edit", "discussion_delete", "discussion_close", "discussion_move", "discussion_merge", "comment_split"

As you can imagine "discussion_merge", "discussion_move", and "comment_split" are actions that only admins can perform and will, likely, not generate a lot of data.

For comments there are "comment_add", "comment_edit", and "comment_delete".

paddykelly

  "properties": {
    "type": {
      "name": "Type",
      "type": "string",
      "enum": [
        "comment_add",
        "discussion_add",
        "comment_delete",
        "comment_edit",
        "comment_split",
        "discussion_close",
        "discussion_delete",
        "discussion_edit",
        "discussion_merge",
        "discussion_move"
      ]
    }

fsmeier

https://success.vanillaforums.com/discussion/comment/9938#Comment_9938

I think this really helped me forward. Because the combination of the endpoint you posted, but also another one I did not fully understand before (/analytics/catalog) gives me the requested strings :)

Thank you very much!

All the best,

Florian