Event metrics keep track of firm users' unread web and mobile [In-app notifications](https://help.clio.com/hc/en-us/articles/9290346939547-Set-Up-Clio-Manage#settings-0-3) and unread [Clio Internal Messages](https://help.clio.com/hc/en-us/articles/9125264015259-Internal-Messages).
openapi: 3.0.0
info:
title: Clio API Documentation Activities Event Metrics API
contact:
name: Clio API Support
email: api@clio.com
description: "# Developer Support and Feedback\n* Clio takes the availability and stability of our API seriously; please report any **degradations** or **breakages** to Clio's API Support team at [api@clio.com](mailto:api@clio.com).\n* For business and partnership inquiries, contact our API Partnerships team at [api.partnerships@clio.com](mailto:api.partnerships@clio.com).\n* For best practices and tips from the Clio development community, join the conversation in the [Clio Developer Slack Channel](https://join.slack.com/t/clio-public/shared_invite/zt-36i0eqgo1-7POORPtMJpp2N0~_auL2IQ).\n\nA community-driven [Clio Developers Stack Overflow Group](https://stackoverflow.com/questions/tagged/clio-api) also exists where you can connect and ask questions from other Clio API users.\n# Getting Started\n> **Note:** The API is available in four distinct data regions: Australia (au.app.clio.com), Canada (ca.app.clio.com), EU (eu.app.clio.com) and US (app.clio.com).\n>\n> Likewise, the developer portal is available at region-specific links for the [Australia](https://au.developers.clio.com), [Canada](https://ca.developers.clio.com), [EU](https://eu.developers.clio.com), and [US](https://developers.clio.com) regions.\n>\n> This document assumes the US region is being used (app.clio.com). If you're building in one of the other regions, you should adapt the links and examples as necessary.\n\nTo start building on the Clio API, you’ll need a Clio account – you can review our [Developer Handbook](https://docs.developers.clio.com/) and follow the steps to sign up for an account.\n\nOnce you have an account, you can [create a developer application](https://docs.developers.clio.com/api-docs/applications) from the [Developer Portal](https://developers.clio.com) and start building!\n# Authorization with OAuth 2.0\nSee our [Authorization documentation →](https://docs.developers.clio.com/api-docs/authorization)\n# Permissions\nSee our [Permissions documentation →](https://docs.developers.clio.com/api-docs/permissions)\n# Fields\nSee our [Fields documentation →](https://docs.developers.clio.com/api-docs/fields)\n# Rate Limiting\nSee our [Rate Limits documentation →](https://docs.developers.clio.com/api-docs/rate-limits)\n# Paging\nSee our [Pagination documentation →](https://docs.developers.clio.com/api-docs/paging)\n# ETags\nSee our [ETags documentation →](https://docs.developers.clio.com/api-docs/etags)\n# Minor Versions\nAPI v4 supports multiple minor versions. Versions are of the form '4.X.Y'. To request a specific version, you can use an `X-API-VERSION` header in your request, with the header value set to the API version you're requesting. If this header is omitted, it will be treated as a request for the default API version. If the header is present but invalid, it will return a `410 Gone` response. If the header is present and valid, but it is no longer supported, it will return a `410 Gone` response.\n\nAn `X-API-VERSION` will be included in all successful responses, with the value being set to the API version used.\n\nYou can find our [API Versioning Policy and Guidelines](https://docs.developers.clio.com/api-docs/api-versioning-policy) in our documentation hub.\n\nThe [API Changelog](https://docs.developers.clio.com/api-docs/api-changelog) explains each version's changes in further detail.\n### [4.0.4](https://docs.developers.clio.com/api-docs/api-changelog#404)\n\n * Update `quantity` field to return values in seconds rather than hours for Activities\n\n### [4.0.5](https://docs.developers.clio.com/api-docs/api-changelog#405)\n\n * Remove `matter_balances` field from Bills\n* Standardize status/state enum values\n* Add a Document association to completed DocumentAutomations\n* Add rate visibility handling for Activity's price and total\n\n### [4.0.6](https://docs.developers.clio.com/api-docs/api-changelog#406)\n\n * Remove `document_versions` collection field from Documents\n\n### [4.0.7](https://docs.developers.clio.com/api-docs/api-changelog#407)\n\n * Change secure link format\n\n### [4.0.8](https://docs.developers.clio.com/api-docs/api-changelog#408)\n\n * `Activity` hours are redacted in the response based on the activity hours visibility setting for the user\n * Add `quantity_redacted` field to activities\n\n### [4.0.9](https://docs.developers.clio.com/api-docs/api-changelog#409)\n\n * Contacts are filtered and redacted in the response based on the new 'Contacts Visibility' user permission setting.\n\n### [4.0.10](https://docs.developers.clio.com/api-docs/api-changelog#4010)\n\n * Fixed validation of `type` query parameter when querying Notes\n\n### [4.0.12](https://docs.developers.clio.com/api-docs/api-changelog#4012)\n\n * Restrict fields for CalendarEntry that should only be visible to event owners, editors, and viewers\n\n### [4.0.13](https://docs.developers.clio.com/api-docs/api-changelog#4013)\n\n **This is the default version**\n\n * Add association limits to Contacts\n* Returns 422 Unprocessable Entity when association limits are exceeded\n\n\n"
version: v4
x-logo:
url: https://www.clio.com/wp-content/uploads/2015/05/Container-5-Logo.png
servers:
- url: https://app.clio.com/api/v4
description: US region Production Server
- url: https://eu.app.clio.com/api/v4
description: Europe region Production Server
- url: https://ca.app.clio.com/api/v4
description: Canada region Production Server
- url: https://au.app.clio.com/api/v4
description: Australia region Production Server
tags:
- name: Event Metrics
description: Event metrics keep track of firm users' unread web and mobile [In-app notifications](https://help.clio.com/hc/en-us/articles/9290346939547-Set-Up-Clio-Manage#settings-0-3) and unread [Clio Internal Messages](https://help.clio.com/hc/en-us/articles/9125264015259-Internal-Messages).
paths:
/internal_notifications/event_metrics.json:
get:
tags:
- Event Metrics
summary: Unread in-app notification events
operationId: EventMetrics#index
description: Outlines the parameters, optional and required, used when requesting Event Metrics
parameters:
- name: X-API-VERSION
in: header
description: 'The [API minor version](#section/Minor-Versions). Default: latest version.'
required: false
schema:
type: string
- name: fields
in: query
description: The fields to be returned. See response samples for what fields are available. For more information see the [fields section](#section/Fields).
required: false
schema:
type: string
responses:
'200':
description: Ok
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/EventMetrics_Show'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
$ref: '#/components/schemas/ErrorDetail'
EventMetrics_Show:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/EventMetrics'
EventMetrics:
allOf:
- $ref: '#/components/schemas/EventMetrics_base'
- type: object
properties: {}
EventMetrics_base:
type: object
properties:
unread_mobile_events:
type: integer
format: int64
description: The number of unread mobile event notifications for the current user
unread_web_events:
type: integer
format: int64
description: The number of unread web event notifications for the current user
unread_secure_messages:
type: integer
format: int64
description: The number of unread secure messages for the current user
unread_client_portal_messages:
type: integer
format: int64
description: The number of unread client portal messages for the current user
unread_text_messages:
type: integer
format: int64
description: The number of unread text messages for the current user
ErrorDetail:
type: object
required:
- type
- message
properties:
type:
type: string
description: Unique name for this error
message:
type: string
description: Detailed message about the error
x-tagGroups:
- name: Api
tags:
- Custom Actions
- Webhooks
- name: Activities
tags:
- Activities
- Activity Descriptions
- Activity Rates
- Expense Categories
- Timers
- Utbms Codes
- Utbms Sets
- name: Accounting
tags:
- Bank Accounts
- Bank Transactions
- Bank Transfers
- name: Billing
tags:
- Bills
- Billable Clients
- Billable Matters
- Bill Themes
- Interest Charges
- Line Items
- Outstanding Client Balances
- name: Calendars
tags:
- Calendars
- Calendar Entries
- Calendar Entry Event Types
- Calendar Visibilities
- Reminders
- name: Clio Payments
tags:
- Clio Payments Links
- Clio Payments Payments
- name: Communications
tags:
- Communications
- Conversations
- Conversation Messages
- name: Contacts
tags:
- Contacts
- Email Addresses
- Phone Numbers
- Notes
- Log Entries
- name: Court Rules
tags:
- Jurisdictions To Triggers
- Jurisdictions
- Matter Dockets
- Service Types
- name: Custom Fields
tags:
- Custom Fields
- Custom Field Sets
- name: Documents
tags:
- Documents
- Document Versions
- Folders
- Document Archives
- Document Automations
- Document Categories
- Document Templates
- Comments
- name: In-app Notifications
tags:
- My Events
- Event Metrics
- name: Matters
tags:
- Matters
- Relationships
- Clients
- Related Contacts
- Matter Contacts
- Notes
- Practice Areas
- Log Entries
- Matter Stages
- Medical Records Details
- Medical Records
- Medical Bills
- Damages
- name: Payments
tags:
- Allocations
- Credit Memos
- name: Reporting
tags:
- Reports
- Report Presets
- Report Schedules
- name: Settings
tags:
- Text Snippets
- Billing Settings
- Currencies
- Tax Rate Configurations
- name: Tasks
tags:
- Tasks
- Task Templates
- Task Template Lists
- Task Types
- name: Trust
tags:
- Trust Line Items
- Trust Requests
- name: Users
tags:
- Users
- Groups
- name: Legal Aid US
tags:
- Grants
- Grant Funding Sources
- name: Legal Aid England & Wales
tags:
- Civil Controlled Rates
- Civil Certificated Rates
- Criminal Controlled Rates
- Expense Categories