ValQ

https://docs.valq.com/
Admin
ValQ is a lightweight, multi-purpose application running on Power BI that supports planning,...
Tokens:45,089
Snippets:891
Trust Score:8.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Querying Documentation with GET Request

Source: https://docs.valq.com/model/formula-functions/math-functions/average.md

This example shows how to dynamically query the ValQ documentation using an HTTP GET request. It includes parameters for asking a specific question and optionally defining a broader goal.

```HTTP
GET https://docs.valq.com/model/formula-functions/math-functions/average.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.valq.com/model/formula-functions/finance-functions/pv.md

Illustrates how to dynamically query documentation using an HTTP GET request with 'ask' and optional 'goal' parameters. This is useful for retrieving specific information or related content not explicitly present on the page.

```HTTP
GET https://docs.valq.com/model/formula-functions/finance-functions/pv.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.valq.com/plan/time-series-forecasting.md

Use this HTTP GET request to query the documentation dynamically. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.valq.com/plan/time-series-forecasting.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with AI Agent

Source: https://docs.valq.com/model/formula-functions/node-properties.md

Perform an HTTP GET request to query documentation dynamically. Use the 'ask' parameter for specific questions and the optional 'goal' parameter to guide the AI towards a broader objective. This is useful when information is not explicitly present on the current page or when seeking clarification.

```http
GET https://docs.valq.com/model/formula-functions/node-properties.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### FV Function Syntax and Example

Source: https://docs.valq.com/model/formula-functions/finance-functions/fv.md

Demonstrates the syntax of the FV function and provides an example of its usage in calculating the future value of an investment with periodic payments. The example shows how to input the interest rate, number of periods, and payment amount.

```ValQ Formula
FV([Interest Rate],[Number of Periods],[Payment],0,0)
```

--------------------------------

### Using GET Function to Reference Past Data

Source: https://docs.valq.com/model/formula-functions/range-functions/get.md

This example demonstrates how to use the GET function to reference a specific period's value from one node and apply it to another. It shows how to get the December 2023 discount rate and use it for all periods in 2024.

```ValQ Formula
[Discount (2023) ].Get(12)
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/model/formula-functions/math-functions.md

Send an HTTP GET request to a documentation URL with the `ask` and `goal` query parameters to dynamically query the content. The `ask` parameter takes a specific question, and the `goal` parameter describes the broader objective.

```http
GET https://docs.valq.com/model/formula-functions/math-functions.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Example: Simple Switch

Source: https://docs.valq.com/model/formula-functions/logical-functions/switch.md

A basic example of the Switch function to return a string based on a numerical input.

```formula
SWITCH(A1, 1, "One", 2, "Two", 3, "Three", "Other")
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/simulate/compare-scenarios.md

Perform an HTTP GET request to the current page URL with the `ask` query parameter for specific questions and an optional `goal` parameter for broader objectives. The response includes a direct answer and relevant sources.

```http
GET https://docs.valq.com/simulate/compare-scenarios.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.valq.com/model/formula-functions/finance-functions/fv.md

Illustrates how to query the documentation dynamically using an HTTP GET request. This is useful for retrieving specific information not explicitly present on the page or for getting additional context.

```HTTP
GET https://docs.valq.com/model/formula-functions/finance-functions/fv.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.valq.com/model/create-model/import-a-model.md

Use this GET request to ask questions about the documentation. Include an 'ask' parameter for your question and an optional 'goal' parameter for the broader objective.

```HTTP
GET https://docs.valq.com/model/create-model/import-a-model.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.valq.com/model/formula-functions/math-functions/averageexneg.md

To get information not explicitly on the page, use an HTTP GET request with the 'ask' parameter. The 'goal' parameter can be optionally included to tailor the response to a broader objective.

```HTTP
GET https://docs.valq.com/model/formula-functions/math-functions/averageexneg.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### PV Function Syntax and Example

Source: https://docs.valq.com/model/formula-functions/finance-functions/pv.md

Demonstrates the syntax of the PV function and provides an example of its usage in calculating the present value of a loan with specific interest rates, periods, and payment amounts. The 'Type' argument indicates when payments are made (0 for end of period, non-zero for start).

```Valq Formula
PV([Interest Rate], [Number of Periods], [Payments Made], 0, 0)
```

--------------------------------

### Query Documentation Page

Source: https://docs.valq.com/model/formula-functions/range-functions/findbytitle.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.valq.com/model/formula-functions/range-functions/findbytitle.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/model/model-editor/node-operations.md

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter and an optional `goal` parameter. The `ask` parameter should contain a specific, self-contained question in natural language, while `goal` describes the broader objective.

```http
GET https://docs.valq.com/model/model-editor/node-operations.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.valq.com/model/create-model.md

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter.

```http
GET https://docs.valq.com/model/create-model.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/simulate/perform-simulations.md

Perform an HTTP GET request to the current page URL with the `ask` query parameter for a specific question and an optional `goal` parameter to describe the broader objective. Use this when the answer is not directly on the page, requires clarification, or you need related documentation.

```http
GET https://docs.valq.com/simulate/perform-simulations.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation Dynamically via HTTP GET

Source: https://docs.valq.com/glossary.md

Use this HTTP GET request to query documentation dynamically when information is not explicitly present on the page. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter to tailor the response.

```http
GET https://docs.valq.com/glossary.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation with HTTP GET

Source: https://docs.valq.com/report/variance-analysis-report.md

Perform an HTTP GET request to query documentation dynamically. Use the `ask` parameter for specific questions and the optional `goal` parameter to tailor the AI's response to a broader objective. This mechanism is useful when information is not explicitly present on the current page or when additional context is needed.

```http
GET https://docs.valq.com/report/variance-analysis-report.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/simulate/understanding-the-node-components.md

Use this endpoint to ask questions about the documentation. The 'ask' parameter specifies the question, and 'goal' provides optional context for the desired outcome.

```http
GET https://docs.valq.com/simulate/understanding-the-node-components.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Example: Nested Switch

Source: https://docs.valq.com/model/formula-functions/logical-functions/switch.md

Illustrates how to nest Switch functions to handle more complex conditional logic.

```formula
SWITCH(A1, 1, SWITCH(B1, 1, "A1=1, B1=1", 2, "A1=1, B1=2"), 2, "A1=2")
```

--------------------------------

### Example: Switch with Boolean Logic

Source: https://docs.valq.com/model/formula-functions/logical-functions/switch.md

Shows the use of Switch with boolean expressions to evaluate conditions.

```formula
SWITCH(TRUE, A1>10, "Greater than 10", A1=10, "Equal to 10", "Less than 10")
```

--------------------------------

### Query ValQ Documentation via HTTP GET

Source: https://docs.valq.com/introduction-to-valq/get-valq.md

Use this endpoint to ask questions about the documentation when the answer is not explicitly present on the page, or when you need clarification or additional context.

```http
GET https://docs.valq.com/introduction-to-valq/get-valq.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/model/get-data.md

Use this method to ask questions about the documentation when the answer is not explicitly present on the current page, or when you need clarification or additional context.

```HTTP
GET https://docs.valq.com/model/get-data.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Incentive Calculation Without FLOOR Function

Source: https://docs.valq.com/model/formula-functions/math-functions/floor.md

This example shows the incentive calculation without the FLOOR function, resulting in potential fractional values for the incentive amount.

```Valq Formula
IF(([Employee Sales]>[Sales Target]),([Employee Sales]-[Sales Target]),0) * 1254 * 0.02
```

--------------------------------

### AVERAGEEXZERO Function Usage

Source: https://docs.valq.com/model/formula-functions/math-functions/averageexzero.md

This example demonstrates how to use the AVERAGEEXZERO function to calculate the average sales across different regions, excluding regions where sales were zero.

```Valq Formula
AVERAGEEXZERO([East],[South],[Central],[West])
```

--------------------------------

### Query ValQ Documentation via HTTP GET

Source: https://docs.valq.com/introduction-to-valq/the-valq-workflow.md

Use this endpoint to ask questions about the documentation dynamically. The `ask` parameter is mandatory for specifying your query, and the `goal` parameter can be used to provide context for a more tailored response.

```http
GET https://docs.valq.com/introduction-to-valq/the-valq-workflow.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/model/templates.md

Use this method to ask questions about the documentation dynamically. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.valq.com/model/templates.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Valq Documentation via HTTP GET

Source: https://docs.valq.com/model/formula-functions/finance-functions/cumipmt.md

Use this endpoint to ask specific questions about the documentation. The 'ask' parameter contains the question, and the optional 'goal' parameter provides context for the desired outcome.

```HTTP
GET https://docs.valq.com/model/formula-functions/finance-functions/cumipmt.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Get Function

Source: https://docs.valq.com/model/formula-functions/range-functions.md

Returns the values of the specified period index.

```APIDOC
## Get

### Description
Returns the values of the specified period index.

### Syntax
.Get(period_index) - > number
```

--------------------------------

### Range Function

Source: https://docs.valq.com/model/formula-functions/range-functions.md

Returns the values between the specified start and end periods.

```APIDOC
## Range

### Description
Returns the values between the specified start and end periods.

### Syntax
.Range(start_index, end_index) - > number
```

--------------------------------

### Query Documentation with GitBook API

Source: https://docs.valq.com/simulate.md

Use this GET request to ask questions about the documentation. Include your specific question in the 'ask' parameter and an optional broader goal in the 'goal' parameter.

```http
GET https://docs.valq.com/simulate.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.valq.com/model/templates/export-template.md

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. 'ask' is the immediate question, and 'goal' is optional and describes the broader end goal.

```HTTP
GET https://docs.valq.com/model/templates/export-template.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### CURRENT_SERIES* Formula Example

Source: https://docs.valq.com/model/formula-functions/static-identifiers/current_series.md

Assigns 100 as the monthly baseline value and 85 as the monthly comparison value using the CURRENT_SERIES formula.

```formula
CURRENT_SERIES == 'base'? 100:85
```

--------------------------------

### Get Comparison Series Range

Source: https://docs.valq.com/model/formula-functions/node-properties/node-properties-explanation.md

Use .tgt.RANGE to retrieve a subset of comparison (target) values from a node. This is useful for tracking progress against targets.

```valq
SUM([Sales].tgt.RANGE(9,12))
```

--------------------------------

### Get Baseline Series Range

Source: https://docs.valq.com/model/formula-functions/node-properties/node-properties-explanation.md

Use .base.RANGE to retrieve a subset of baseline values from a node. This is useful for comparing actual performance against a baseline.

```valq
SUM([Sales].base.RANGE(9,12))
```
Tokens:
Raw