Get tag analytics across entities

Request

Returns aggregated tag usage data across Campaign, Redemption, Business, TokenMetadata, and UserStatusType entities. Useful for tag filtering in apps and autocomplete suggestions.

Security

projectKey

Query

entityTypesArray of strings

Filter by entity types. If omitted, returns tags from all taggable entities.

Items Enum:"campaign""redemption""business""token_metadata""user_status_type"

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/analytics/tags?entityTypes=campaign' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Tag analytics successfully retrieved

Bodyapplication/json

tagsArray of objects(TagUsageDTO)required

List of tags with usage information

totalTagsnumberrequired

Total number of unique tags

Example:25

totalUsagenumberrequired

Total tag usage count (sum of all tag assignments across all entities)

Example:150

entityTypesArray of stringsrequired

Entity types included in this aggregation

Items Enum:"campaign""redemption""business""token_metadata""user_status_type"

Example:

[
  "campaign",
  "redemption",
  "business",
  "token_metadata",
  "user_status_type"
]

Response

{
  "tags": [
    { … }
  ],
  "totalTags": 25,
  "totalUsage": 150,
  "entityTypes": [
    "campaign",
    "redemption",
    "business",
    "token_metadata",
    "user_status_type"
  ]
}