---
title: "Exporting Data with Web Services"
slug: "exporting-data-with-web-services"
description: "Slate supports the ability to create custom web services using the Query Builder."
updated: 2026-02-25T22:56:10Z
published: 2026-02-25T22:56:10Z
---
> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.technolutions.net/llms.txt
> Use this file to discover all available pages before exploring further.
# Exporting Data with Web Services
Any Slate [query](/v1/docs/queries-overview) can be routinely called as a web service or scheduled to push data into another system.
## Calling a Slate query as a web service
> [!NOTE]
> 🔑 Requires [Administrator (All Access) Role](/v1/docs/users-permissions)
To generate an endpoint that can be called via web services:
1. Go to **Queries / Reports**.
2. Select **New Query.**
3. Configure the following settings:
- **Type:**Configurable Joins
- **Category/Base:**Select according to the data you want to export.
4. Select **Save.**
5. [Add exports and filters as needed](/v1/docs/query-basics).
6. Select **Edit Web Service.**
### Edit web service
Configure the following settings:
#### Custom parameters
If you wish to pass in values through the query string, add to the Parameters field using the following format:
```xml
```
The parameter `id` can be used in a [formula](/v1/docs/subquery-filters#formula-0-7) by entering `@variable_name`.
- `id`**:**The variable name used in the query string, and SQL query with `@`
- The following parameter IDs are reserved and should never be used: callback, base, run, query, user, identity, id, h, and output. You will notice the use of id, h, and output in the service endpoints. These parameters should be static and represent the following:
- `id`: the query ID
- `h`: a salted hash of the query ID and an additional authentication check
- `output`: the service type.
- `type`**:** Parameter data type (Acceptable**Parameter Types**)
- `date`
- `datetime`
- `varchar`
- `int`
- `real`
- `uniqueidentifier`
- `bit`
- `label`**:** Value display to the user in the query tool user interface
#### Service type
Select the appropriate service type:
- JSON
- XML
- Excel
- CSV/Google Sheets
- Disabled
#### Include NULLs
Select **Include NULL Values** to include `NULL`s in your exported data.
Select **Save.**
### Edit permissions
Authentication is required for web services.
To add authentication:
1. Select **Edit Permissions**
2. Select **Add Grantee.**
3. From the *Type*list, select **User Token**or **Username.**If your query exposes sensitive data, you must select **Username**to keep your data secure.
4. If you select **User Token**, configure the following settings:
- **Name:**Enter a descriptive name. This will appear in the Edit Permissions window alongside any other custom query permissions.
- **Token:**When calling this web service, provide the Token using the `h` query string parameter.
- **Allowed Networks:**If you want to limit the IP addresses that can call this web service, enter individual IP addresses or [CIDR subnets](/v1/docs/cidr-notation-for-ip-subnets) .
- **Permissions:**Select **Web Service**. [](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/8128148477339.png)
5. If you select **Username**, configure the following settings:
- **Name:**Give it a descriptive name. This will appear in the Edit Permissions window alongside any other custom query permissions.
- **Username/Password:**Enter a Username and a Password. These must be provided when the web service is called.
- **Token:**When calling this web service, provide the Token using the `h` query string parameter.
- **Allowed Networks:**If you want to limit the IP addresses that can call this web service, enter individual IP addresses or [CIDR subnets](/v1/docs/cidr-notation-for-ip-subnets).
- **Permissions:**Select **Web Service.**[](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/8128305384219.png)
6. Select **Save.**
### Exports and filters
To pass in query string parameters, such as `dtstart` and `dtend`, append a string like `&dtstart=1/1/2000&dtend=1/1/2099` to the service.
If you prefer to export the data via JSON with a callback (also known as JSONP), you can pass a callback function name to the `callback` query string parameter.
The query may use the parameters by using the `@` symbol with the parameter ID.
You can do this with a direct filter:
[](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/8127398851099.png)
Or in a [formula subquery](/v1/docs/subquery-filters#formula-0-7):
[](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/8127545121563.png)
### Service endpoint
To locate your service endpoint:
1. Select the **service type link**(varies depending on your choice) next to **Web Services.** 
2. Select a **service account**to display connection instructions.
The endpoint URL appears.
#### Call rate limit
Each database is rate limited to 300 requests and 300 seconds of web service request processing within any 5-minute interval.
#### Default encoding
If you need to change the default encoding (UTF-8) when calling a Slate query as a web service, add the encoding parameter to the call URL in the following format:
```plainText
&encoding=iso-8859-1
```
## Pushing data to remote web services
1. Go to **Queries / Reports.**
2. Select the query.
3. Select **Edit Query.**
4. Select **Schedule Export**.
5. Configure the following settings:
- **Destination:**Web Service (Remote)
- **Endpoint:**Paste the endpoint
- **Headers:**Add optional HTTP [headers](/v1/docs/exporting-data-with-web-services#headers)
- **Notification:**You can opt to receive notifications for success, failure, and late delivery
- **Format:**Select JSON or XML
- **Requested Delivery Window (Eastern Time):**Select one of the available delivery windows
6. Select **Save.**
The query runs at the time of the delivery window and push the data to the endpoint.
## Headers
All Web Service transactions take place across the [Hyper Text Transfer Protocol](https://developer.mozilla.org/en-US/docs/Web/HTTP) (HTTP & HTTPS).
Part of this protocol is the optional inclusion of [HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers) which can be used to, among many other uses, authenticate users and communicate query parameters.
In Slate, custom headers may also be defined for the web service using the following format:
```xml
header_value
```
Multiple headers can be added by repeating the format for each header name/value pair.
Consult the documentation for the Web Service or API you are attempting to reach to determine which headers, if any, ought to be included with the Web Request.
### Examples of frequently used HTTP headers
#### Authorization header using basic authentication
To produce an HTTP Authorization Header using [basic authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization#examples), create a string composed of your username, a colon(:) and your password for the remote Web Service. Encode that string as Base 64 and add the header as follows:
```xml
Basic YOUR-BASE-64-ENCODED-CREDENTIALS
```
#### Resulting HTTP Request Sample
```plaintext
POST /service/resource HTTP/1.1
Host: example.com
Authorization: Basic YOUR-BASE-64-ENCODED-CREDENTIALS
```
#### Authorization header using bearer authentication
To produce an HTTP Authorization Header using a [bearer token](https://swagger.io/docs/specification/v3_0/authentication/bearer-authentication/), include bearer as the authentication scheme and your bearer token:
```xml
Bearer YOUR-TOKEN-HERE
```
#### Resulting HTTP Request Sample
```plaintext
POST /service/resource HTTP/1.1
Host: example.com
Authorization: Bearer YOUR-TOKEN-HERE
```
#### Including an API key in an HTTP header
Many APIs use their own authentication structure but a common structure is to use API "Keys", essentially large cryptographically-generated numbers unique to each user.
These keys can be passed to the Remote Web Service or API in a number of ways but a common way is to include the API Key in the HTTP Headers.
The following is an example where the Remote Web Service is expecting an HTTP Header with the name of YOUR-API-KEY-HEADER-NAME and the value of YOUR-API-KEY-VALUE:
```xml
YOUR-API-KEY-VALUE
```
#### Resulting HTTP Request Sample
```plaintext
POST /service/resource HTTP/1.1
Host: example.com
YOUR-API-KEY-HEADER-NAME: YOUR-API-KEY-VALUE
```