Skip to main content

Data Extraction API

Overview

The Data Extraction API enables you to export data from Skills Workflow into external tools and systems—such as Excel, Power BI, or custom applications—by dynamically querying named data sets.

Purpose

The Data Extraction API is intended for reading and exporting data from Skills Workflow in a structured and efficient way. It is ideal for reporting, dashboards, and integration with external BI or analytics tools.

Use Cases

Export data from Skills Workflow to:

  • Excel, Power BI, Google Sheets
  • Custom dashboards or internal reporting systems
  • Third-party analytics tools
  • Automation tools like Zapier or Make (Integromat)
  • Data warehouses or ETL pipelines

Key Limitations

  • Read-only: This API does not support creating or updating records.
  • Depends on predefined data sets.
  • Pagination recommended: Use pagination (skip/take) for large queries to avoid timeouts or incomplete results.
  • Rate limits may apply: For high-frequency requests, consider caching or batching.

Getting Started

Authentication

Before calling any endpoint, you must obtain the following credentials from our Support team:

  • App Key (X-AppId)
  • App Secret (X-AppSecret)
  • Tenant ID (X-AppTenant)

These are provided by the support team upon request.

Include them in each request via HTTP headers:

X-AppTenant:  <X-AppTenant>
X-AppId: <X-AppId>
X-AppSecret: <X-AppSecret>
X-AppUser: <UserId> # Optional, if user-scoped filtering is required
Content-Type: application/json

Environments

The API is available in four environments, depending on your subscription plan:

  • Development
  • Test
  • UAT
  • Production

Each environment has its own base URL:

{{ApiUrl}}/api/v3/analytics

Postman Collection

To facilitate testing of the available queries, we provide a Postman collection file with all endpoints configured. You can download it from the link below:

Download Postman Collection - Data Extraction

After downloading, make sure to configure the variables {{ApiUrl}}, {{TenantId}}, {{AppId}}, {{AppSecret}}, and {{UserId}} according to the credentials you have been given.

Rate Limits

Note: Each request must complete within 30 seconds.

  • Apply filters to narrow the data set.
  • Use pagination (skip / take) to retrieve large data sets in chunks.

Filtering Data

To flexibly extract data, use the queryBuilder object in your POST body. It supports:

PropertyTypeDescription
skipintegerNumber of records to skip (for pagination).
takeintegerMaximum number of records to return.
orderByarrayList of { field, direction } objects to sort results.
fieldsarrayList of field names to include in the response.
filtersarrayComplex filters combining expressions, e.g. [["Status","=","Open"],"and",["Priority",">",2]].
{
"queryBuilder": {
"skip": 0,
"take": 100,
"orderBy": [
{ "field": "UserId", "direction": "asc" }
],
"fields": ["Team", "UserId"],
"filters": [
["Team", "=", "Executor"],
"or",
["Team", "=", "Requester"]
]
}
}

Discovering Available Fields

To know which fields you can request, perform an initial call with only pagination:

POST {{ApiUrl}}/api/v3/analytics/named-query/DE-Clients/dynamic-execute
Headers:
X-AppTenant: <TenantId>
X-AppId: <AppKey>
X-AppSecret: <AppSecret>
Body:
{
"queryBuilder": {
"skip": 0,
"take": 100
}
}

This returns up to 100 records and reveals all available properties in the response schema, which you can then reference in subsequent queryBuilder.fields and queryBuilder.filters.


Endpoints

The collection includes several dynamic-execute endpoints, each under:

POST /api/v3/analytics/named-query/{NamedQuery}/dynamic-execute

Where {NamedQuery} is one of:

  • DE-Attendences
  • DE-Assignments
  • DE-Brands
  • DE-Cities
  • DE-Clients
  • DE-ClientsCompanies
  • DE-Contracts
  • DE-Companies
  • DE-CompaniesAdditionalInformation
  • DE-Countries
  • DE-Currencies
  • DE-Departments
  • DE-Descriptions
  • DE-Divisions
  • DE-Employees
  • DE-EstimatedPlannedActualMonthly
  • DE-Estimates
  • DE-EstimatesCount
  • DE-EstimatesQuotes
  • DE-EstimatesQuotesMonth
  • DE-EstimatesQuotesMonthCount
  • DE-ExpenseTypes
  • DE-Expenses
  • DE-ExpenseSheets
  • DE-Holidays
  • DE-Jobs
  • DE-JobsCount
  • DE-Leaves
  • DE-LeavesCount
  • DE-LeavesDeleted
  • DE-LeavesDeletedCount
  • DE-Products
  • DE-Projects
  • DE-ProjectsCount
  • DE-ProjectsAdditionalInformation
  • DE-ProjectsPlannedTime
  • DE-ProjectsPlannedTimeCount
  • DE-RateCardsColumns
  • DE-Stages
  • DE-Suppliers
  • DE-TimeSheets
  • DE-TimeSheetsCount
  • DE-TimeSheetsDeleted
  • DE-TimeSheetsDeletedCount
  • DE-Typologies
  • DE-TypologyGroups
  • DE-UserCosts
  • DE-Users
  • DE-UsersToBlock
  • DE-UsersToUnblock
  • DE-UserTypes
  • DE-UsersAdditionalInformation
  • DE-WorkTypes

Example Usage

Retrieve Filtered Assignments

POST {{ApiUrl}}/api/v3/analytics/named-query/DE-Assignments/dynamic-execute
Headers:
X-AppTenant: <TenantId>
X-AppId: <AppKey>
X-AppSecret: <AppSecret>
X-AppUser: <UserId>
Body:
{
"queryBuilder": {
"skip": 0,
"take": 50,
"orderBy": [
{ "field": "User", "direction": "asc" }
],
"fields": ["Team", "UserId", "AssignmentDate"],
"filters": [
["Team", "=", "Executor"],
"or",
["Team", "=", "Requester"]
]
}
}

Sample Response

{
"data": [
{ "Team": "Executor", "UserId": "U123", "AssignmentDate": "2025-04-01T09:30:00Z" },
{ "Team": "Requester", "UserId": "U456", "AssignmentDate": "2025-04-02T14:45:00Z" }
// …
],
"totalCount": 124
}