Skip to content

fix fql references in docs #3761

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 7, 2022
Merged

fix fql references in docs #3761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b1949a
Move FQL references from Config to PAPI.
Nov 4, 2022
c217a53
[netlify-build] test out PR build.
Nov 4, 2022
a584130
Fix redirect
Nov 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/_data/sidenav/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,8 +475,13 @@ sections:
title: Verifying Your Email Address
- section_title: API
section:
- path: /api/public-api
title: Public API
- section_title: Public API
slug: api/public-api
section:
- path: /api/public-api
title: Public API
- path: /api/public-api/fql
title: Destination Filter Query Language
- section_title: Config API
slug: api/config-api
section:
Expand All @@ -486,8 +491,6 @@ sections:
title: API design
- path: /api/config-api/authentication
title: Authentication
- path: /api/config-api/fql
title: Destination Filter Query Language
# - path: "https://reference.segmentapis.com/"
# title: Reference
# menu_icon: new-tab
Expand Down
2 changes: 1 addition & 1 deletion src/api/config-api/fql.md → src/api/public-api/fql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ You can use parentheses to group subexpressions for more complex "and / or" logi
| `length( list or string )` | `number` | Returns the number of elements in a list or number of bytes (not necessarily characters) in a string. For example, `a` is 1 byte and`ア` is 3 bytes long. |
| `lowercase( s string )` | `string` | Returns `s` with all uppercase characters replaced with their lowercase equivalent. |
| `typeof( value )` | `string` | Returns the type of the given value: `"string"`, `"number"`, `"list"`, `"bool"`, or `"null"`. |
| `match( s string, pattern string )` | `bool` | Returns `true` if the glob pattern `pattern` matches `s`. See below for more details about glob matching. |
| `match( s string, pattern string )` | `bool` | Returns `true` if the glob pattern `pattern` matches `s`. See below for more details about glob matching. |

Functions handle `null` with sensible defaults to make writing FQL more concise.
For example, you can write `length( userId ) > 0` instead of `typeof( userId ) =
Expand Down
2 changes: 2 additions & 0 deletions src/api/public-api.md → src/api/public-api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Public API
redirect_from:
- '/public-api'
---
The Segment Public API helps you manage your Segment workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs.

Expand Down
2 changes: 1 addition & 1 deletion src/connections/destinations/destination-filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To create a destination filter:

## Destination filters API

The destination filters API provides more power than Segment's dashboard destination filters settings. With the API, you can create complex filters that are conditionally applied using Segment's [Filter Query Language (FQL)](/docs/api/config-api/fql/).
The destination filters API provides more power than Segment's dashboard destination filters settings. With the API, you can create complex filters that are conditionally applied using Segment's [Filter Query Language (FQL)](/docs/api/public-api/fql/).

The destination filters API offers four different filter types:

Expand Down