GET Users & notifications

Count User Notifications

URL PROPERTIES userid : required Return only notifications for this user BODY PROPERTIES filterNotificationTypes : optional Return only events of the specified type.

GET /api/v3/{appid}/user/users/{userid}/notification/countnotifications

URL PROPERTIES

userid : (required) Return only notifications for this user

BODY PROPERTIES

filterNotificationTypes : (optional) Return only events of the specified type. Pass the argument more than once to fetch multiple types of notifications at once.
- chatmention
- chatquote
- chatreply
- commentmention
- commentquote
- commentreply
includeread : (optional | default = false) If true, notifications that have already been read are counted otherwise read notifications are not counted
filterChatRoomId : (optional) If provided, this will only count notifications associated with the specified chat room using the ChatRoom ID (exact match)
filterChatRoomCustomId : (optional) If provided, this will only count notifications associated with the specified chat room using the Custom ID (exact match)

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The application the user belongs to.

Example: your-app-id

userid path

string customer-defined required

Required. Return only the notification count for this user.

Example: u-8842

UserId query

string customer-defined

Required. Return only notifications for this user the route's userid; also accepted as a form field .

Example: u-8842

FilterNotificationTypes query

NotificationTypes[]

Optional. Return only events of the specified type s : chatmention, chatquote, chatreply, commentmention, commentquote, commentreply. Pass the argument more than once to fetch multiple types at once. Omit to return all types.

Example: 1

FilterChatRoomId query

string

Optional. Restrict results to notifications associated with this chat room ID exact match .

FilterChatRoomCustomId query

string customer-defined

Optional. Restrict results to notifications associated with this chat room custom ID exact match .

FilterCommentConversationId query

string

Optional. Restrict results to notifications associated with this comment conversation ID exact match .

FilterCommentConversationCustomId query

string customer-defined

Optional. Restrict results to notifications associated with this comment conversation custom ID exact match .

IncludeRead query

boolean

Optional, default false. If true, notifications that have already been read are also returned/counted.

Example: true

Cursor query

string

Optional. Pass the cursor value from a previous response to resume paging; leave blank to start from the beginning.

Limit query

integer · int32

Optional. Default 50, maximum 200. Limits how many items are returned per page.

Example: 1

Dieroll query

integer · int32

If non zero, a die will be rolled with this number of sides. If the roll is not a 1 the request gets a 200 response instantly and no work is done.

Example: 1

Response

Status codes

Every JSON response uses the API result envelope.

200 OK: success data is a ResponseCountUserNotifications itemcount . ApiResult

400 BadRequest: required fields are missing or invalid. ApiResult

403 Forbidden: request is not authorized with a valid token, or the token does not match this appid. ApiResult

500 Internal Server Error ApiResult

curl --request GET \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/user/users/${USER_ID}/notification/countnotifications?UserId=u-8842&FilterNotificationTypes=1&IncludeRead=true&Limit=1&Dieroll=1" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}"

const appId = process.env.TALKLABS_APP_ID;
const userid = 'u-8842';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/user/users/${userid}/notification/countnotifications?UserId=u-8842&FilterNotificationTypes=1&IncludeRead=true&Limit=1&Dieroll=1`,
{
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
  },
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
userid = "u-8842"

response = requests.get(
    f"https://api.sportstalk247.com/api/v3/{app_id}/user/users/{userid}/notification/countnotifications?UserId=u-8842&FilterNotificationTypes=1&IncludeRead=true&Limit=1&Dieroll=1",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response