Console Dashboard Overview

Video Overview

The following video provides an overview of the various portions of the console.gnip.com dashboard.

Products Tab

Upon logging into your account at console.gnip.com, you will land on the "Products Tab" of the dashboard. This overview page includes all of the full-fidelity products currently added to your account, and features the Stream Type, the number of connections currently running for each, the number of rules currently active for each (where applicable), and the raw number of activities delivered in the most recent 24 hours.

It also contains helpful information and links to your other premium products, like Historical PowerTrack, and any Enterprise Data Collectors associated with your account. It will resemble the following:

Stream Overview

Clicking on one of the streams in the main dashboard will take you to an overview page fo that stream.

This page includes 1) a volume chart of the number of activities being delivered to you through each specific stream connection, 2) details (connection ID and IP address) on currently active connections on the stream, 3) and a log of recent connection, disconnection, and rule-update events for your stream.

Note that the scale of the chart may be adjusted with the links in the top-right corner, and the visibility of individual connections and disconnections can be toggled by clicking the appropriate key in the legend directly below the chart.

Note on partitioned Streams, the console will show 3 connections for the scenario below:
Connect to decahose partition=1
Connect to decahose partition=1 (second ‘redundant’ connection to partiion 1)
Connect to decahose partition=2

Connections

The Connections page provides details on recent connection events on your stream. This includes the start and end times for each connection (in 24 hour UTC), the duration of each connection, the IP of the server that made the connection, a unique connection ID for reference purposes, and the current connection status. The status corresponds to the most recent event for the specified connection – i.e. Client Connected, or a disconnect, with the type of disconnect specified.

API Help

The API Help page provides the API endpoint URLs for your stream, as well as the Rules API endpoint for the stream, where applicable. In addition, it includes sample curl commands and instructions on how to connect to the stream endpoint, and how to programmatically add, delete, and list rules from your stream's Rules API endpoint.

Rules

The Rules tab is available for PowerTrack streams, and provides a quick way to get started by manually entering plain text rules via a user interface. Note that the interface only supports adding up to 1000 rules via this manual method, and should be only used for initial testing. We recommend you managing your rules programmatically via the API in any production setting.

Settings

The Settings tab allows you to switch the output format of the data in your stream, where multiple format options are supported. To switch the format, just use the radio buttons indicating the different options. The change will take effect upon reconnecting to the stream.

Usage Tab

The Usage Tab provides insight into your use of your streams over various time periods. For programmatic access to usage information, see the Usage API.

Monthly

The Monthly Usage page displays your stream usage broken down by product. For example, coverage products (e.g. PowerTrack, Historical PowerTrack, and PowerTrack Replay) for a given data source will be grouped together to provide separate data, as well as a combined roll-up count. The counts include a current month-to-date, estimated end-of-month (based on this month’s usage so far, and remaining time in the month), and the previous two months’ counts.

Notably, these counts are deduplicated for each product and stream. If you received the same Tweet through multiple connections to the same PowerTrack stream, that Tweet will be counted once for these purposes. Counts will be updated every 24 hours at 00:00 UTC.

Daily

The Daily Usage page provides daily deduplicated counts for each day in the current month, broken down by product. Counts are updated every 24 hours at 00:00 UTC.

Today

Today’s Usage provides the usage on your products for the current day (in UTC time). Note that this presents non-deduplicated counts for each product type, and should be viewed as a raw breakdown of the total activity volume delivered across all your connections for the given product, rather than the deduplicated unique activity counts shown in the other pages.

Account Tab

My Profile

View details about your individual user profile, and change your password here. Additionally, you may configure individual notification emails for Gnip Status updates (from status.gnip.com) and usage thresholds you configure for yourself here.

Account Settings

View info about the account including the notification email set up to receive alert emails for forceful disconnects for a full buffer on your streams. You may also add, remove, and edit users, and configure email notifications for individual users for Gnip Status notices, and usage threshold alerts.

Note that there are three types of users – Account Admin, User, and Email Only. Account admins are allowed to create/delete/edit other users, while users cannot. Email Only users do not have access to the dashboard, and only receive Status notifications, if they are configured to receive them in the Notifications section.

To add a new user to your Gnip account:

Login to console.gnip.com with your Account Admin Gnip credentials
Navigate to the “Account” tab at the top of the page
Select “Account Settings”
Select “New” next to “Users”
Create a new account with the desired email and account settings.
The new user will receive an activation email from Gnip, click on the link to activate. If you do not receive this email, please check your spam folder. If it is not in your spam folder, email [email protected].
New User is set to go.

To delete a user:

You cannot delete an account’s Admin User without first designating a new Admin User. Additionally, before deleting a user, make sure that your application is not using this user’s credentials to authenticate. If it is, please be sure to change the credentials used to authenticate.

Login to console.gnip.com with your Account Admin Gnip credentials.
Navigate to the “Account” tab at the top of the page
Select “Account Settings”
Locate the User you would like to delete
Select “Delete”

To change the email associated with Gnip Notifications:

This is generally the email address that you gave us get your account setup. We generally recommend using a generic email address for this.

Email the Support Team at [email protected] to take care of this
Once the Support Team has taken care of it, make sure that any streams that relied on your old credentials are updated to work with your new credentials.

To change your password:

If your application uses the account with the password that you’re changing to connect to our APIs, make sure that you update the credentials in your application.

Login to console.gnip.com with your current Gnip credentials
Navigate to the “Account” tab at the top of the page
Under the “My Account” tab, which is the page you’re brought to, select “Change Password.”
Enter current password, then your desired password, click “Change Password.”

To enable email notifications from the [Gnip Status Dashboard](https://status.gnip.com/):

We use status.gnip.com to communicate about the status of our APIs, scheduled and unscheduled maintence, and upcoming product changes. If think that something has gone awry with a Gnip API, this is the first place to check. Enabling these email notifications will send you an email whenever we post to status.gnip.com

Login to console.gnip.com with your Gnip credentials.
Navigate to the “Account” tab at the top of the page
On the “My Profile” page, select the “Gnip Status Notifications” under “Email Notifications.”
Admin users can turn on or off email notifications for their regular users by navigating to the “Account Settings” page and selecting “edit” next to their users’ accounts. From there, select which notifications you’d like your users to receive.

To enable month to date usage threshold emails:

Please note that usage thresholds in this sense just let you know that you are approaching consumption of a specified number of Tweets. Unless otherwise stated in your agreement, your stream(s) will continue to stream data even if you surpass the amount of data that you specify here.

Login to console.gnip.com with your Gnip credentials
Navigate to the “Account” tab at the top of the page
On the “My Profile” page, select the “Usage Threshold (MTD) Notices” under “Email Notifications.”
Admin users can turn on or off email notifications for their regular users by navigating to the “Account Settings” page and selecting “edit” next to their users’ accounts. From there, select which notifications you’d like your users to receive.

*Email notifications are provided as a courtesy to help you be aware of potential data overage scenarios. As with any email, they are subject to being spam filtered or buried in your inbox. As you are ultimately responsible for any overages incurred, we encourage you to build your own monitoring solutions and remind you that usage can be monitored at any time in the 'Usage' section of the Console or through the [Usage API](http://support.gnip.com/apis/usage_api.html).*

To edit your usage threshold:

Login to console.gnip.com with your Gnip credentials.
Navigate to the “Account” tab at the top of the page.
From there, click on “Usage Thresholds”
Select “Edit”
Set the thresholds at which you’d like to receive notifications
Select “Save”

Usage Thresholds

Configure volume thresholds for your products. These will initiate email alerts for the users who have configured those notifications in their profiles, both for the warning threshold and critical threshold for each product. Note that these thresholds are evaluated once per day at 12:30 AM Mountain Time (Denver), and are not evaluated in real time.

Console Dashboard