Back to Speed website

Search Tips

Suggest Edits

Use the Speed dashboard search functionality to search for payments, and more. This built-in search feature can help you find essential resources and navigate across different Speed resources.

It allows you to search for objects belonging to a specific resource type and apply filters. The searchable resource types are listed below.

Use [is] before the resource name, and then type in more filters if you want to minimize the number of matches for the search.

To refine your search, preface a search term with one of the following filters. Many fields are shared across different objects. For example, the "amount" field applies to payments, checkout links, and more. In such cases, using the [is] filter will yield more precise matches within the top 10 results.

When you perform a search, the top 10 results will appear directly in the dropdown below the search box. To view all matches, either click “Show all results” or press Enter. You will then be directed to a detailed results page, which will have all the search results organized based on the resource type.

The top 10 matches shown are sorted in descending order by the timestamp created. This is the default sort applied by Speed search. To sort results using different filters, use sort in your query, as shown below:

Use the field sort: with the following clause:

ValueExampleDescription
createdsort:-createdSorts the result set by the newest record first (Default)
amountsort:-amountSorts the result set by the highest amount first
amountsort:amountSorts the result set by the lowest amount first

Additionally, you can use (-) to negate the query, as shown in the above example.

Example: is:payment amount>100 sort:-amount

  • This will search for payment objects that have an amount greater than 100. The resulting list will be sorted in descending order based on the amount field.

Filters

The dashboard automatically searches for the most relevant information based on your query terms. You can use search filters and operators to have more granular control. The more terms you include in your search query, the more refined the results will be.

Field NameTypeOperatorsUsageDescription
CurrencyToken:(is)currency:”usd”The three-letter ISO code for currency.
AmountNumeric:(is)
..(is between)
<(less than)
<=(less than or equal)
=(equals)
>(greater than)
>=(greater than or equal)		amount>1000The amount of an object.
NameString:(is)name:"John"In the context of products, the "Name" parameter refers to the name of the product.

When dealing with customer-related functionality, the "Name" parameter represents the name of the customer.
Target CurrencyToken:(is)target_currency:”sats”The crypto-currency used for the object.
Target AmountNumeric..(is between)
<(less than)
<=(less than or equal)
=(equals)
>(greater than)
>=(greater than or equal)		target_amount:10..20The amount of an object in target currency.
Target Amount PaidNumeric:(is)
..(is between)
<(less than)
<=(less than or equal)
=(equals)
>(greater than)
>=(greater than or equal)		target_amount_paid>1000The amount of funds are transferred for a payment resource.
IDString:(is)id:”pi_l3v6fgis9h9YcDIV”The ID of the object is matched.
DescriptionString:(is)
~(contains)		description:”order id:23”Additional information about the payment resource.
StatusToken:(is)status:”paid”The status of an object such as, “active”, “expired”, “deactivated” and others.
CreatedNumeric:(is)
..(is between)
<(less than)
<=(less than or equal)
=(equals)
>(greater than)
>=(greater than or equal)		created=12-29-2022The date an object was created.
Statement DescriptorString:(is)
~(contains)		statement_descriptor:”payment”The statement descriptor given to a payment resource.
Billing phoneString:(is)billing_phone: "7506119541”Customer’s phone number
URLString:(is)url:”cs_test_l3mvy93hxOTgrJAV”The URL of the resource.
ISToken:(is)is:”payment”The object for search
Sort:(is)sort:createdThe object which will be used for sorting.
EmailString:(is)email:[email protected]The email address present in an object.
MetadataToken:(is)metadata:value_1The data of the metadata object whose value matches the search keyword.

Operators

To refine your search within a specific range, you can use the following operators:

TYPEOPERATORS
tokenexact match (case insensitive)
stringexact match (:), substring (~)   (case insensitive)
numeric>(greater than)
<(less than)
<=(less than or equal)
>=(greater than or equal)
=(equals)
..(is between)

For more proper matches, formulate queries using the fields mentioned below. For more details, refer to Speed SQL. You can use the following operators to formulate your query.

Different ways to use created filter:

ValueExampleOperators
today- created:today:
=
>
<
>=
<=
yesterday-created<yesterday:
=
>
<
>=
<=
yyyy/MM/dd
yyyy-MM-dd
yyyy-M-dd
yyyy-MM-d
yyyy-M-d
yyyyMMdd		created<=20221229:
=
>
<
>=
<=
MM/dd/yyyy
MM-dd-yyyy
M/dd/yyyy
M-dd-yyyy
MM/dd/yy
MM-dd-yy		created=12-29-2022:
=
>
<
>=
<=
dd/MM/yyyy
dd.MM.yyyy
dd/M/yyyy
dd.M.yyyy
d/M/yyyy
d.M.yyyy
dd/MM/yy
dd.MM.yy		created:29/12/2022:
=
>
<
>=
<=
last- created:”last 100 minutes” - created=”last 2 hours” -:
=
>
<
>=
<=
pastcreated>=”past 5 months” - created<=”past year”:
=
>
<
>=
<=
ago- created>”10 weeks ago” - created<”150 minutes ago”:
=
>
<
>=
<=
timestampcreated>=1672298100223:
=
>
<
>=
<=

Currency conversions and time zone differences between you and your customer can cause confusion when looking up payment information. In such cases, additional search terms. To get relevant matches for your search, make sure to set your date format in your profile settings. If you haven't done so yet, the default date format precedence will be used as follows:

  1. yearMonthDay
  2. dayMonthYear
  3. monthDayYear

Suppose the date format is mm-dd-yyyy set in the profile then precedence will be,

  1. yearMonthDay
  2. monthDayYear
  3. dayMonthYear

Bookmark searches

We include the search terms in the URL. So, you can bookmark the search or share it with other team members as you would with any other web page.

Updated 3 months ago