LogoLogo
DocsCreator GuideIntegration Guide
  • Introduction
  • Why Monterosa?
  • Platform Buyer FAQ
  • Engagement Use Cases
    • Event Centres
    • Prediction Games
    • Voting
    • Trivia Challenges
    • Competitions & Sweepstakes
    • Sports Data Visualisation
    • Native Apps
    • Global Replication
  • Core Platform Concepts
    • Platform Components
    • App Settings
    • Schedule & Events
    • Timeline
    • Elements
    • Extensions
    • EnMasse Mesh
  • 🎨Creator Guide
    • Welcome
      • Getting an Account
    • Spaces
      • Projects
        • Events
          • Event Templates
          • Event Settings
          • Timeline
            • Elements
            • OpenAI Integration
            • Live Stats
            • Preview
            • Embedding
              • Embedding an Element
          • Analytics
        • Project Settings
          • Localisation
          • Experience URL
          • Content Creation Limits
        • App Settings
        • Activity Log
      • Content
        • Asset Library
        • Automation
          • 🔃Bulk Content Uploader
          • ⚡Live Data Connector
      • Setup
        • Space Settings
        • Apps
        • Integrations
          • Opta Graphics
          • Tagboard
        • Extensions
          • Identify
          • Gamify
          • Forms
          • Geo-Verify
          • Content Bridge
          • Vote Verification
    • Experiences
      • Experience Creator
        • Customising your UI
        • Retrieving Event URLs
    • Team
      • Two-Factor Authentication
      • Setting Up SSO to log in the Monterosa platform
      • User Roles
    • Scaling & Capacity
    • Creator FAQs
  • 🚀Integration Guide
    • Overview
    • Standalone Pages
    • Web Page Embedding
      • Hosting an Experience on your domain
      • Auto-resizing embedded Experiences
    • Native App Embedding
    • Embed using the SDK
    • Discovering Events Programmatically
    • Audience Profiles
      • Audience Profiles Dataset Reference
        • Users dataset
        • Projects dataset
        • Events dataset
        • Elements dataset
        • Interactions dataset
        • Leaderboard (Event) dataset
        • Leagues dataset
        • Form entries dataset
      • Monterosa Identifiers
    • Integrating Identity with your site or app
      • Set up identity using the SDK & JWT
      • Using JWT without the SDK
      • Custom Identity Adaptors
    • Consent Management integration
      • Client-Side Data Storage Explained
    • Analytics integration
    • Integration FAQs
  • 📱FanKit
    • Overview
    • How it works
    • Elements
      • Polls & Voting
        • Brand Survey
        • Poll
        • Reaction Rater
        • Ladder Poll
        • Swing Poll
        • Smash Rater
        • Category Wrapper
        • Category Vote
        • Standalone Vote
        • Team Selector
      • Predictors
        • Predictor
        • Sweepstake
        • Number Predictor
        • Podium Predictor
        • Score Predictor
        • Score Predictor (High)
        • Player Predictor
      • Trivia
        • Trivia
        • Free Type Trivia
        • Ladder Trivia
        • Sorting Trivia
        • Word Trivia
        • Video Trivia
        • Number Trivia
      • Editorial & Media
        • Article
        • External Article
        • Commentary
        • Gallery
        • Image
        • Video
        • Video Carousel
        • Shareable URL
        • Social Embed
        • Form
        • Element Carousel
        • Match Event
        • Substitution
        • Goal
        • Time Event
        • Topic
      • Quiz
        • Quiz Wrapper
        • Quiz Question
      • Series Prediction
        • Series Wrapper
        • Series Score Predictor
        • Series Predictor
        • Series Number Predictor
        • Series Player Predictor
      • Multi Rater
        • Ratings Wrapper
        • Ratings Slider
      • Sports Statistics
        • Opta Widget
        • Stat Callout
        • Stat Comparison
      • Gamification
        • Scoreboard (Event)
        • Scoreboard (Round)
        • Leaderboard (Project)
        • Leaderboard (Event)
        • Leaderboard (Round)
        • Leaderboard (Group)
    • Tips, tricks, tutorials & guides
      • Advanced CSS Overrides
      • Using points and leaderboards
      • Content containers
    • Display Modes
    • Converters
      • Access Gate
      • Form
      • Cards
      • Share Image
      • Featured Links
      • Sponsors
      • Promo Banner
      • Google Ads
    • Localisation
    • Supported Browsers
    • Release Notes
  • 👣DEVELOPER GUIDE
    • Overview
    • Platform Terminology
    • Interaction SDK
      • Download & Initialise the SDK
      • Supported Devices & Operating Systems
      • Roadmap
      • Release Notes
        • React Native
          • v0.2.2
        • JavaScript
          • v0.17.0
          • v0.16.16
          • v0.16.15
          • v0.16.14
          • v0.16.13
          • v0.16.12
          • v0.16.11
        • iOS
          • v0.16.12
          • v0.16.11
        • Android
          • v0.16.13
      • SDK FAQs
    • Embedding Apps
      • Static Embedding
      • Dynamic Embedding
        • Web Behaviours
        • iOS Behaviours
        • Android Behaviours
        • Preloading
        • Caching Content
        • Shared Storage
      • Configure your app
      • Communicate with embedded apps
      • Video Stream Sync
      • React Native
        • Events in React Native SDK
      • Integrate with Flutter
    • Building Apps
      • Quick Start Guide
      • How to build your first app
        • Getting started
        • Get your app running locally
        • Install the Interaction SDK
        • Define your App
        • Set up Studio
        • Develop your App
        • Enable Dynamic Configuration
      • Core SDK Functions
        • Getting and displaying Events
        • Managing Elements
        • Reacting to live updates
        • Dynamic runtime configuration
        • Time
        • Localisation
    • Content Automation
      • Discovering Events
      • Connecting to Google Sheets
      • Connecting to Zapier
      • Connecting to Sports Feeds
    • App Specs
      • App Spec Reference
        • Root Spec
        • Elements Spec
        • Project Settings Spec
        • Event Settings Spec
        • Expressions (beta)
        • Data Sources (beta)
        • External data source
        • Field Types
          • Boolean
          • Collection
          • Colour
          • Datetime
          • External
          • File
          • Freetext
          • Image
          • List
          • Number
          • WYSIWYG
        • Field, Field set, Field section
      • Customising App Specs
    • Available APIs
    • Integrating TV Graphics
    • Advanced Topics
      • Listings
      • Accesssing user concurrency values from your app
      • Custom analytics Extension
      • Front-end app communication protocols
      • Multi Vote
      • Reveal answer on vote
  • ⚙️CONTROL API
    • Overview
    • Objects Definitions
    • Element Reference
    • Organisations
      • Get Organisations
      • Get Organisation
      • Create Organisation
      • Update Organisation
      • Delete Organisation
    • Spaces
      • Get Spaces
      • Get Space
      • Create Space
      • Update Space
      • Delete Space
    • Apps
      • Get Apps
      • Get App
      • Create App
      • Reload App
    • App Settings
    • Projects
      • Get Projects
      • Get Project
      • Create Project
      • Update Project
      • Delete Project
    • Events
      • Get Events
      • Get Event
      • Get Event Service Feeds
      • Create Event
      • Create Event From Template
      • Update Event
      • Delete Event
    • Event Templates
      • Get Event Templates
      • Get Event Template
      • Create Event Template
      • Update Event Template
      • Delete Event Template
    • Elements
      • Get Elements
      • Get Element
      • Get Event Template Elements
      • Create Element
      • Update Element
      • Delete Element
    • Assets
      • Get Assets
      • Upload Assets
      • Update Asset
      • Delete Asset
      • Get Asset Media Types
      • Get Asset Uploaders
      • Asset Tags
        • Add Tag to Asset
        • Remove Tag from Asset
    • Tags
      • Get Tags
      • Get Tag
      • Create Tag
      • Update Tag
      • Delete Tag
  • ⚙️REFERENCE
    • Public Feeds
      • Graphics Feed
    • Listings
    • Elements
    • Event History
    • Demographics
    • Identify
    • Gamify
      • Gamification Mechanics
      • Public API
      • Private API
    • Geo-Verify
    • Browser Support
    • Audience API (Preview)
      • Authentication
        • Monterosa Access Token
        • Public client authentication
      • Batched operations
      • Loyalty API
      • Connections API
    • Image Resizing API
  • ⛓️Extensions
    • Overview
    • Instance handshake
    • Project handshake
    • Project delete
    • Tabs
    • Event Tabs
    • Setup
    • Listings notification
    • Elements notification
    • Analytics
    • Assets
    • Event-level feed
    • Webhooks
  • ⚖️COMPLIANCE
    • Data Requests
    • Data Sub-processors
    • Hosting Locations
    • Third party software
    • ISO27001
  • 🗒️RELEASE NOTES
    • Studio
      • v30.0
      • v29.0
      • v28.0
      • v27.0
      • v26.0
      • v25.0
    • FanKit
      • v24.41.0
      • 24.42.0 Preview
    • Archive
      • v24 releases 2022-23
Powered by GitBook
On this page

Was this helpful?

  1. REFERENCE
  2. Audience API (Preview)

Connections API

Connections API lets users build relationships like "following" or "friendship", boosting engagement and retention.

Last updated 8 months ago

Was this helpful?

Connections API (part of the Audience API) is a high-throughput public RESTful API that enables social UX mechanics, such as one-way "following" or mutual "friendship." It allows users to form meaningful relationships within Interactive Experiences, share progress, collaborate and compete with each other, thus increasing app usage, engagement and retention.

All methods of Connections API require authentication.

GET requests are paginated to allow for potential celebrity mass-following.

Following

Following is a not-necessarily-mutual form of social engagement, where one user may follow another without requiring their explicit approval. API methods below allow a client app to retrieve the lists of "followees" and "followers" for a user, as well as manage their following.

Friendship

Following is a mutual form of social engagement, where one user makes a friendship request, that must be approved by the other user before the relationship is established. The API methods below allow a client app to retrieve a user's active friends, sent and received friend requests, and manage these lists.

Stats

⚙️

List users the specified user is following

get
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
limitinteger · min: 1Optional

The maximum number of items to return.

Default: 100
Responses
200
Paginated list of users
application/json
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
get
GET /api/connections/following HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*
{
  "message": "OK",
  "data": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "avatar": "text"
    }
  ],
  "meta": {
    "total": 20,
    "offset": 0,
    "limit": 100
  }
}

Unfollow a user

delete
Authorizations
Path parameters
target_user_idstring · uuidRequired

UUID of the target user.

Responses
204
User unfollowed successfully.
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
delete
DELETE /api/connections/following/{target_user_id} HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*

No content

List users following the specified user

get
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
limitinteger · min: 1Optional

The maximum number of items to return.

Default: 100
Responses
200
Paginated list of users
application/json
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
get
GET /api/connections/followers HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*
{
  "message": "OK",
  "data": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "avatar": "text"
    }
  ],
  "meta": {
    "total": 20,
    "offset": 0,
    "limit": 100
  }
}

List friends of the specified user

get
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
limitinteger · min: 1Optional

The maximum number of items to return.

Default: 100
Responses
200
Paginated list of users
application/json
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
get
GET /api/connections/friends HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*
{
  "message": "OK",
  "data": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "avatar": "text"
    }
  ],
  "meta": {
    "total": 20,
    "offset": 0,
    "limit": 100
  }
}

List sent friend requests

get
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
limitinteger · min: 1Optional

The maximum number of items to return.

Default: 100
Responses
200
Paginated list of users
application/json
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
get
GET /api/connections/friends/requests/sent HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*
{
  "message": "OK",
  "data": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "avatar": "text"
    }
  ],
  "meta": {
    "total": 20,
    "offset": 0,
    "limit": 100
  }
}

Delete previously sent friend request

delete
Authorizations
Path parameters
target_user_idstring · uuidRequired

UUID of the target user.

Responses
204
Friend request deleted successfully.
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
delete
DELETE /api/connections/friends/requests/sent/{target_user_id} HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*

No content

List received friend requests

get
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

offsetintegerOptional

The number of items to skip before starting to collect the result set.

Default: 0
limitinteger · min: 1Optional

The maximum number of items to return.

Default: 100
Responses
200
Paginated list of users
application/json
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
get
GET /api/connections/friends/requests/received HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*
{
  "message": "OK",
  "data": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "avatar": "text"
    }
  ],
  "meta": {
    "total": 20,
    "offset": 0,
    "limit": 100
  }
}

Approve a received friend request

patch
Authorizations
Path parameters
target_user_idstring · uuidRequired

UUID of the target user.

Responses
200
Friend request approved successfully.
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
patch
PATCH /api/connections/friends/requests/received/{target_user_id} HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*

No content

Get an overview of the user's connections

get
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

user_idsstringOptional

Comma-separated list of UUIDs of the users. Enables batch query mode.

Responses
200
Specified user's connection counts
application/json
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
get
GET /api/connections HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Accept: */*
{
  "message": "OK",
  "data": {
    "following_count": 18,
    "followers_count": 34,
    "friends_count": 14,
    "requests_received_count": 7,
    "requests_sent_count": 3
  }
}
  • Following
  • GETList users the specified user is following
  • POSTFollow a user
  • DELETEUnfollow a user
  • GETList users following the specified user
  • Friendship
  • GETList friends of the specified user
  • GETList sent friend requests
  • POSTSend a friend request
  • DELETEDelete previously sent friend request
  • GETList received friend requests
  • PATCHApprove a received friend request
  • Stats
  • GETGet an overview of the user's connections

Follow a user

post
Authorizations
Query parameters
user_idstring · UUIDOptional

UUID of the user. Defaults to the current user.

Body
target_user_idstring · uuidRequired

UUID of the target user.

Responses
201
User followed successfully.
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
post
POST /api/connections/following HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "target_user_id": "123e4567-e89b-12d3-a456-426614174000"
}

No content

Send a friend request

post
Authorizations
Body
target_user_idstring · uuidRequired

UUID of the target user.

Responses
201
Friend request sent successfully.
401
No access token supplied, or supplied token is invalid. Inspect `Www-Authenticate` header for error description
application/json
post
POST /api/connections/friends/requests/sent HTTP/1.1
Host: your.space.domain
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "target_user_id": "123e4567-e89b-12d3-a456-426614174000"
}

No content