Event Types

This page lists all event types returned by the Content Reporting service. Use these values with the eventType parameter to filter your exports.

What you'll learn:

• All available event types organized by category
• What triggers each event type
• How to filter exports by specific events
• Which lookup tables relate to each event category

TL;DR

• App events: app-opened, channel-used, experience-tracked-event
• Asset events: asset-in-app-viewed, asset-shared, shared-asset-viewed
• Share events: share-created, share-viewed, share-reshared
• Shared Space events: sharedspace-created, sharedspace-viewed, and more

Prerequisites

• Plan: Ultimate | Advanced or Expert
• Permissions: Administrator access to Showpad's Admin App
• Authentication: Valid OAuth 2.0 access token (learn more)

When to Use Event Filtering

Content Analytics	Share Performance	Shared Space Tracking	Custom Reporting
Track which assets are viewed and downloaded most frequently.	Measure how prospects engage with shared content.	Monitor collaboration activity in Shared Spaces.	Build custom dashboards by filtering specific event types.

Event Categories

Event-to-Table Mapping

When analyzing events, you'll need to join with lookup tables for additional context. This table shows which tables are relevant for each event category.

Event Category	Related Lookup Tables	Common Join Fields
App / Experience	Users, Channels, Devices	userId, channelId, deviceId
Assets	Assets, Users, Divisions, Tags	assetId, userId, divisionId
Shares	Shares, Assets, Users, Contacts	shareId, assetId, userId, contactId
Shared Spaces	Sharedspaces, Sharedspaceparticipants, Sharedspace-items, Users	sharedspaceId, participantId, userId

info

For complete field definitions and relationships, see Lookup Relations.

Common Scenarios

Track Content Engagement

Measure how your sales team uses content internally and how prospects engage with shared content.

Relevant events: asset-in-app-viewed, asset-in-app-downloaded, shared-asset-viewed, shared-asset-downloaded

Measure Share Effectiveness

Analyze the full share funnel from creation to prospect engagement.

Relevant events: share-created, share-email-opened, share-viewed, share-reshared

Monitor Shared Space Collaboration

Track the complete lifecycle of Shared Space activity and prospect participation.

Relevant events: sharedspace-created, sharedspace-invited-participant, sharedspace-joined, sharedspace-viewed, sharedspace-viewed-asset

Usage Examples

Filter by Single Event Type

cURL

curl -X GET "https://{subdomain}.showpad.biz/api/v3/exports/events.json?eventType=asset-shared" \
  -H "Authorization: Bearer {access_token}"

JavaScript

const response = await fetch('https://{subdomain}.showpad.biz/api/v3/exports/events.json?eventType=asset-shared', {
  headers: { Authorization: 'Bearer {access_token}' },
});
const data = await response.json();

Python

import requests

url = "https://{subdomain}.showpad.biz/api/v3/exports/events.json"
params = {"eventType": "asset-shared"}
headers = {"Authorization": "Bearer {access_token}"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

Filter by Multiple Event Types

cURL

curl -X GET "https://{subdomain}.showpad.biz/api/v3/exports/events.json?eventType=share-viewed,share-created,share-reshared" \
  -H "Authorization: Bearer {access_token}"

JavaScript

const response = await fetch(
  'https://{subdomain}.showpad.biz/api/v3/exports/events.json?eventType=share-viewed,share-created,share-reshared',
  {
    headers: { Authorization: 'Bearer {access_token}' },
  }
);
const data = await response.json();

Python

import requests

url = "https://{subdomain}.showpad.biz/api/v3/exports/events.json"
params = {"eventType": "share-viewed,share-created,share-reshared"}
headers = {"Authorization": "Bearer {access_token}"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

Combine with Date Filtering

cURL

curl -X GET "https://{subdomain}.showpad.biz/api/v3/exports/events.json?eventType=asset-in-app-viewed&startedAt=2024-01-01&endedAt=2024-03-31" \
  -H "Authorization: Bearer {access_token}"

JavaScript

const response = await fetch(
  'https://{subdomain}.showpad.biz/api/v3/exports/events.json?eventType=asset-in-app-viewed&startedAt=2024-01-01&endedAt=2024-03-31',
  {
    headers: { Authorization: 'Bearer {access_token}' },
  }
);
const data = await response.json();

Python

import requests

url = "https://{subdomain}.showpad.biz/api/v3/exports/events.json"
params = {
    "eventType": "asset-in-app-viewed",
    "startedAt": "2024-01-01",
    "endedAt": "2024-03-31"
}
headers = {"Authorization": "Bearer {access_token}"}

response = requests.get(url, params=params, headers=headers)
print(response.json())

Example Response

When filtering by event type, you'll receive events matching your criteria:

{
  "meta": {
    "count": 2
  },
  "response": {
    "items": [
      {
        "id": "evt_abc123",
        "eventType": "asset-shared",
        "userId": "usr_xyz789",
        "assetId": "ast_def456",
        "shareId": "shr_ghi012",
        "contactId": "cnt_jkl345",
        "startedAt": "2024-03-15T10:30:00Z"
      },
      {
        "id": "evt_abc124",
        "eventType": "asset-shared",
        "userId": "usr_xyz789",
        "assetId": "ast_mno678",
        "shareId": "shr_ghi012",
        "contactId": "cnt_jkl345",
        "startedAt": "2024-03-15T10:30:00Z"
      }
    ]
  }
}

info

The fields returned vary by event type. Asset events include assetId, share events include shareId and contactId, and Shared Space events include sharedspaceId.

Best Practices

Performance Tips

• Filter by date first: Always use startedAt and endedAt to reduce data volume before filtering by event type
• Batch related events: Request related event types together (e.g., all share events) to minimize API calls
• Use pagination: For large datasets, use the X-Showpad-Scroll-Id header to paginate through results
• Cache lookup data: Export lookup tables (Users, Assets, etc.) separately and cache them locally to reduce joins

Data Considerations

• Offline events: Events from offline app usage retain original timestamps but may appear later in exports. Use loggedAt to detect sync timing.
• Deleted records: Events may reference deleted users or assets. Join with lookup tables and check deletedAt fields.
• Page-level events: Asset view events include both page-level and document-level entries. Filter page = NULL for document totals only.

Next Steps

• Lookup Relations: Field definitions and table relationships
• Example Queries: SQL examples for analyzing exported data