Knowledge Base
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Orbit API

Using filters

Available on Starter, Growth, Premium & Enterprise plans
Available on Growth, Premium & Enterprise plans
Available on Premium & Enterprise plans
Available on the Enterprise plan

Filters are a powerful way to narrow down the data you’re looking at and find the information you care about most. But with so many filter options, it can sometimes feel overwhelming to get started! This article will examine each filter option that we currently offer so that you’ll know exactly how to use them.

Where can I find filters?

Filters are currently present on the Members tab, Activities tab, and Reports tab. We provide the same filters on each of these tabs.

What filter options do I have?

Currently you can filter these tabs by:

  • Timeframe
  • Role (member vs teammate)
  • Activity Type
  • Activity Property
  • Member Tag
  • Orbit Level
  • Location
  • Organization
  • Title (job title)

How many filters can I choose?

You can choose one filter or select several filters. If you select several filters, then results must match all filter types selected.

e.g. If you selected the following filters:

  • Time frame: last 30 days
  • Orbit level: Level 1 or Level 2
  • Location: Europe

Then results will show all data performed in the last 30 days by any members in Europe who are in Orbit Level 1 or 2.

Now let’s step through each filter option.

Timeframe

Filtering by time frame returns any data that has been collected within that period.

Examples:

  • On the Activities tab, you’ll see all activities that occurred within the given time frame (and match the rest of the filters)
  • On the Members tab, you’ll see all members that performed an activity (that matches the rest of the filters) within the given time frame.

There are two timeframe filter options: relative and custom.

To select relative time frame (e.g. Past 30 days, Past year), use the dropdown on the right to choose a default option.

Click the right hand button to show the dropdown.

If you’d like to choose your own relative time frame (like Past 13 days), click relative, input a number, and click the check mark.

Click this 'relative' button to show the custom relative timeframe option.

To select a custom time frame (e.g. Jan 13, 2022 - Jan 15, 2022), click the calendar and select the dates you want to use.

Role

This filter is great for helping you filter out your own teammates so you can just focus on the members in your community

Use this filter to look for everyone in your community, just teammates (your collaborators in your workspace), or just members (the people in your community).

Activity Type

The activity type filter shows all the activity types in your workspace. You can scroll or use the search bar to find the activity type you care about.

Using the activity type filter will narrows your results to only those that match any of your selected activity types.

Examples:

  • In the activities tab, this will only show activities that match at least one of the activity types selected (in the time frame selected, if any).
  • In the members tab, this will show members who have performed at at least one of the activity types selected (in the time frame selected, if any).
Check any of the activity types you care about and then click 'Apply'.

Activity Property

The activity property filter narrows results to only those that match any of the selected activity properties.

Examples:

  • In the activities tab, this will only show activities that match at least one of the activity properties selected.
  • In the members tab, this will show members who have performed at at least one of the activity properties selected.

The activity property filter shows all the activity properties in your workspace. You can scroll or use the search bar to find the activity property you care about.

This will filter for all activities/members that mention @OrbitModel on Twitter.

Member Tag

The member tag filter narrows results to only those that match a member that has any of the selected member tags.

Examples:

  • In the activities tab, this will only show activities performed by members with any of the selected member tags.
  • In the members tab, this will show members with any of the selected member tags.

If you need more powerful member tag filtering, you can use the advanced option. This allows you to filter for members without a specific tag, members with all of the selected tags, etc.

In the advanced tag filters, you can choose to include or exclude any of the tags you select or all of the tags that you select.

Orbit Level

The orbit level filter narrows results to only those that match a member that has any of the selected Orbit Levels.

Location

The locations filter narrows results to only those that match a member that has any of the selected locations.

You have the option to filter locations by region, country, or city.

Organization

The organizations filter narrows results to only those that match a member whose profile contains any of the selected organizations.

Title

The title filter narrows results to only those that match a member whose profile contains any of the selected job titles.

New / Returning

This filter is only available when a Timeframe filter is selected.

The New / Returning filters is helpful when trying to see who did their first activity (or a recurring activity) in a given timeframe

The New filter narrows results to only return “new” members in the context of the other filters, and the considered timeframe. Said otherwise, it will return members whose first activity matching the filters was in the selected timeframe.

For example, given the following set of filters:

  • Activity Type: Merged GitHub Pull Request
  • Timeframe: Last 3 months
  • New / Returning: New

The results will show members who merged their first PR in the last 3 months.

The Returning filter narrows results to only return “returning” members in the context of the other filters, and the considered timeframe. Said otherwise, it will return members who had a matching activity before the selected timeframe and at least one during the selected timeframe.

For example, given the following set of filters:

  • Activity Type: Attended Meetup
  • Timeframe: Last 3 months
  • New / Returning: Returning

The results will show members who attended one or more meetups before three month ago, and one or more meetups during the last 3 months.

--

And that's it! Now that you've learned how to use filters, let's next look at how to save your selected filters using saved views.

Related articles

Still stuck?
or