Skip to content

Commit

Permalink
docs: sql-api page added (#4)
Browse files Browse the repository at this point in the history
Co-authored-by: Ivan Fokeev <vanya@vanya.cc>
  • Loading branch information
tgyfs and ifokeev authored Jan 28, 2024
1 parent 4b8fc47 commit b92cda9
Show file tree
Hide file tree
Showing 149 changed files with 167 additions and 949 deletions.
4 changes: 2 additions & 2 deletions docs/user-guide/explore/alerts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Follow these steps to efficiently set up your alerts:

## How to Set Up an Alert

1. Click the "Create Alert" button on the Explore page.
1. Click the "Add Alert" button on the Explore page.
![Alerts Page Creation](/docs/img/alert1.png)

1. Choose your notification delivery method. Options include Webhook, Slack, or Email, depending on your system integrations and preferences.
Expand All @@ -31,7 +31,7 @@ Follow these steps to efficiently set up your alerts:

This section offers a comprehensive overview of the Alert or Report setup. Key features include:

**Query Key**: This is the primary metric that your alert or report is based on. It's a critical element in the monitoring process.
**Query Key**: This is the primary query that your alert or report is based on. It's a critical element in the monitoring process.

**Measures**: Select the quantitative data points you wish to track or display. These are crucial for your analysis and will be highlighted in the Preview.

Expand Down
16 changes: 5 additions & 11 deletions docs/user-guide/explore/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,17 @@ Picking the right dimensions and measures is super important for looking at your

1. **Go to the Sidebar**: First, find the sidebar.

2. **Click on Your Model**: There's a part that says 'Model'. Click it and you'll see a list.
2. **Click on Desired Model**: Click it and you'll see a list.

3. **See All the Options**: This list shows all the dimensions and measures you can use.
3. **See All the Options**: This list shows all the measures, dimensions, time dimensions and segments you can use.

4. **Pick What You Need**: Choose the ones that are right for what you're doing.
4. **Pick What You Need**: Choose the ones that you're willing to analyze.

5. **Run Your Query**: After picking, run your query to see your data.

:::tip

- **Quick Find**: Use the search box to find dimensions or measures fast.
- **Types of Dimensions**: You can pick from time, string, number, boolean, and geo.
- **How Dimensions Look**: They can be in formats like images, links, or percentages.
- **Measures are Numbers**: They usually show quantities.
- **Measure Formats**: Like percentages or currency.

:::

Expand Down Expand Up @@ -126,14 +122,12 @@ The toolbar in your data analysis tool is equipped with a variety of features to
- `Authorization: Bearer <token>`
- `x-hasura-datasource-id: <datasource-id>`
- `x-hasura-branch-id: <branch-id>`
- **URL**: `http://cube.synmetrix.org/api/v1/load`
- **URL**: `https://cube.synmetrix.org/api/v1/load`
- **Body**: Follow the API documentation for accurate setup.

**Execute API Request**: Enables sending an API request directly from the interface.

**REST API Documentation**: Access the link for comprehensive API usage instructions and details.


import DocCardList from '@theme/DocCardList';

<DocCaЫrdList />
<DocCardList />
2 changes: 1 addition & 1 deletion docs/user-guide/explore/reports/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Now, you can proceed with creating and configuring your report.

## How to Create a Report

1. Click the "Create" button on the Explore page.
1. Click the "Add Report" button on the Explore page.
![Reports Page](/docs/img/report1.png)

1. Select the destination where the screenshot will be sent. You can choose between Webhook, Slack, or Email based on your preferences and integrations.
Expand Down
65 changes: 0 additions & 65 deletions docs/user-guide/explore/usage-examples/index.md

This file was deleted.

71 changes: 0 additions & 71 deletions docs/user-guide/interface/alerts-page.md

This file was deleted.

40 changes: 0 additions & 40 deletions docs/user-guide/interface/datasources-page.md

This file was deleted.

Binary file removed docs/user-guide/interface/img/Models3.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/alerts1.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/alerts2.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/alerts3.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/data1.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/data2.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/data3.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/logs1.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/logs2.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/logs3.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/models1.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/models2.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/models4.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/models5.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/models6.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/report1.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/report2.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/report3.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test1.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test10.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test11.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test12.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test13.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test2.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test3.png
Binary file not shown.
Binary file removed docs/user-guide/interface/img/sql-test5.png
Diff not rendered.
Binary file removed docs/user-guide/interface/img/sql-test6.png
Diff not rendered.
Binary file removed docs/user-guide/interface/img/sql-test7.png
Diff not rendered.
Binary file removed docs/user-guide/interface/img/sql-test8.png
Diff not rendered.
Binary file removed docs/user-guide/interface/img/sql-test9.png
Diff not rendered.
Binary file removed docs/user-guide/interface/img/team.png
Diff not rendered.
23 changes: 0 additions & 23 deletions docs/user-guide/interface/index.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/user-guide/interface/logs-page.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/user-guide/interface/models-page.md

This file was deleted.

Loading

0 comments on commit b92cda9

Please sign in to comment.