Using Control Center

Using Control Center to manage your plan, explore the API and search

With Control Center you can discover and manage the API and all of the demand intelligence data your business needs in a single place. You can find Control Center at control.predicthq.com.

Options in Control Center

Navigating within Control Center is easy, at the top, you'll have four options:

  1. Plans

  2. Settings

  3. Help

  4. Profile

Plans

Clicking on the plan summary icon in the top right will show you more details on your plan. Here you can see all of the details of your plan including event visibility, category access and add-ons.

alt

You'll either start off with a trial subscription with limited access or you may be on a paid plan. If you want access to more cities, greater historic visibility, more categories or add-ons, click on the relevant field to open the Upgrade Request feature. Select the options you would like to request to expand your subscription.

Settings

The Account Settings functionality allows you to manage your profile, invite other users to your organization, view billing details and manage a range of other settings for your subscription.

alt

Help

In the navigation options in the top right of Control Center you can also access Help details as shown below.  Select this option to find API documentation, link to our Support knowledge base and to Contact us. You can also use Submit events to submit feedback to us for Loop.

alt

Profile

Clicking on your initials in the top right allows you to switch organizations and logout.  Switching organizations is available if your account is a member of multiple organizations.

alt

The Dashboard

When you log into Control Center you are taken to the dashboard. This view enables you to see your API usage, check out your plan details and request access to more data.

alt

The Sidebar

The sidebar lets you access all the functionalities within Control Center, this includes:

  1. API Tools

  2. Search

  3. Impact

  4. Beam

  5. Notifications (if on Premium Plans)

API Tools

API Clients

The first step to interacting with the PredictHQ API is to create an API Client. You can do this from the API Clients section in Control Center.

alt

Under API Clients, select "New Client" or the "+" button. Give the API Client a title, description, select which scopes the token will have access to, and save. Your API Client will be created, and credentials generated for it.

Remember: You MUST save the secret somewhere, as you won't be able to see it again.

alt

Now that you have an API Client you can generate a token for it. When viewing the Client, select "Create an access token". You can give the token a description and select which scopes the token will have access to. To complete this guide your token will need to have the "Events" scope, but the others are optional.

After entering the client secret you saved earlier, select "Create new token" and save the generated token somewhere - as with the client secret, you won't be able to see it again within Control Center.

Remember: You MUST save the token somewhere, as you won't be able to see it again.

alt

After creating the client it shows in your list of clients.

alt

Now you have an API client you can call the API. See https://docs.predicthq.com/ for more details. You can also use the API Explorer feature of Control Center to explore the capabilities of the API.

API Explorer

Clicking on API explorer in the left navigation menu will allow you to explore the capabilities of the API and generate code.

alt

Note: Using an API Access token is optional since you're already logged in.

Now choose the parameters you want to search, filter or sort on to find the events that impact you. Click on view code to generate code to copy and paste to get a POC up and running quickly.

Click on run now to run your API query and see the results.

alt

Choose from the list of endpoints at the top of API Explorer to explore the API for each.

alt

Search

Find events with our easy-to-use search tool. Increase visibility into the millions of different events happening around the world to understand which ones may have an impact on your business. See results in a variety of ways, including a list, map or calendar view.

alt

Note that search is set up to show events that you have access to under your subscription.  So if you have access to specific cities like New York and Boston you will only see events from those cities.

The timezone used in the search is the timezone set in your profile within Control Center.

To use it, choose the categories, locations, ranks and date range you want to search on:

alt
alt

Choose your sort values and run your search to see a list of events that you have access to under your plan.

alt

Try our map view to see the events on a map.

alt

The calendar will show you upcoming events in a week, month or year view.

alt

Aggregate Event Impact in Control Center

The impact tab in Control Center gives you access to a graph view of the Aggregate Event Impact feature. Choose the location, rank type, event status, and date range to view the total impact of all events by day for the selected time period. This shows you the total impact of all events per day for the given location in the selected time period.

alt

Click on a figure in the table and it will take you to a list of events on that day for the given category.

Note: The Aggregate Event Impact API is being deprecated and replaced with the Features API. Use the features API to pull aggregated attendance data like that shown above in the graph.