Versus API Endpoints

This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.

• Clients

• Dashboard

• Email Templates

• Profanity Filter

• Scouts

Current version: [v0.1.0][dist]

Clients

This has functions for managing clients.

• Add Campaign

• Add Comparison

• Add Member

• Add Question

• Create Client

• Create Member

• Delete Comparison

• Delete Member

• Edit Client

• Generate Report

• Get Campaigns

• Get Client

• Get Comparisons

• Get DocRef

• Get Members

• Get Questions

• Get Responses

• Update Client

Dashboard

This has functions for retrieving mentions

• Today Summary: Today's mentions on social media, news, and other sources

• Week Summary: This week's mentions on social media, news, and other sources

• Month Summary: This month's mentions on social media, news, and other sources

• All Time Summary: Total aggregate on our systems of mentions on social media, news, and other sources

• Today Details: Mentions from social media, news, and other sources grouped by source for today

• Week Details: Mentions from social media, news, and other sources grouped by source for the past week

• Today Details: Mentions from social media, news, and other sources grouped by source for the past month

• All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems

Email Templates

This has functions for sending out emails

• Custom Alerts: Notify an admin that custom alerts have been set for their account

• Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing

• Designated Primary Email: Notify an admin that they have been designated as a primary contact

• Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment

• Request a Demo: Let a potential user request a demo

• Respond to Article: Notify a recipient to respond to a social media post

• Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created

• Your Report: Dispatch a periodic report

Profanity Filter

This function will take a string and return a HTML formattted string with tags that decorate profane words.

Scouts

This has functions required for scouts to interact with campaigns:

• Add Response

• Create Scout

• Get Campaigns

• Get DocRef

• Get Questions

• Get Responses

• Get Scout

Tixy API Endpoints

This documentation lists the API endpoints required for engineers on the Tixy team to interface with Tixy Backend. The API endpoints are generally grouped into the following.

• To-do: edit the bullet points for Tixy docs

Versus-2.0 API Endpoints

This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus-2.0 Backend. The API endpoints are generally grouped into the following.

• Scouts

• Dashboard

Others

• Send WhatsApp Message

Getting started

All endpoints are REST. The default method is POST unless otherwise specified. There is a base URL to which you will need to append the endpoint.

Method: POST

Base_URL: https://us-central1-versus-dev-212614.cloudfunctions.net/