Checklist Analytics

FloQast External API (1.0.0)

Authentication

Requests to FloQast's API must be authenticated using an API key. The API key must be included in the x-api-key header of each request and can be generated in the FloQast application. The key should also have the correct permissions to access the API endpoints you are using. Directions to generate an API key

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://developer.floqast.app/_mock/content/api-reference/openapi/

https://fq-api.floqast.app/

https://fq-api.eu.floqast.app/

https://fq-api.au.floqast.app/

Checklists

Operations

Reconciliations

Operations

Checklist Analytics

Operations

Get Checklist Analytics

Request

This API endpoint enables fetching a collection of checklists performed during a specific month and year. By providing the desired month and year as parameters, the API response narrows down the results to the exact period, facilitating the analysis of financial data and tracking the progress of checklist efforts." And also include information about TLCs.

Query
filter[month]string

Specifies the month for which the checklists should be retrieved. Valid values are the names of the months. Must be used in conjunction with filter[year]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

Example: filter[month]=march
filter[year]integer

Specifies the year for which the checklists should be retrieved. It should be a four-digit numerical value. Must be used in conjunction with filter[month]. Required if neither filter[modifiedBefore] nor filter[modifiedSince] is provided.

Example: filter[year]=2023
filter[modifiedBefore]string(date)

Sets the cutoff date for retrieving checklists, including only those modified before (but not including) the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedBefore] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

Example: filter[modifiedBefore]=2021-01-01
filter[modifiedSince]string(date)

Sets the cutoff date for retrieving checklists, including only those modified on or after the specified date. The date must be in the format YYYY-MM-DD. While filter[modifiedSince] is required if filter[month] and filter[year] are not provided, it can also be used in conjunction with these filters for more specific queries.

Example: filter[modifiedSince]=2020-12-31
filter[entityIds]string

Comma separated entity ids for which the checklists should be retrieved.

Example: filter[entityIds]=5e94d5b63f557b001420bbe1,5e94d5b63f557b001420bbe2
filter[workflowIds]string

Comma separated workflow ids for which the checklists should be retrieved

Example: filter[workflowIds]=5e94d5b63f557b001420baa1,5e94d5b63f557b001420baa2
page[size]integer

The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.

Example: page[size]=12000
page[cursor]string

Pagination cursor that indicates the starting position for the next set of items

Example: page[cursor]=5e94d5b63f557b001420bbe3
allowRedirectboolean

If set to true, the API will return a 303 redirect response if the response payload is too large. The header Location and body.data.url will also include the URL to the actual resource.

Example: allowRedirect=true
curl -i -X GET \
  'https://developer.floqast.app/_mock/content/api-reference/openapi/api/v1/analytics/checklists?allowRedirect=true&filter%5BentityIds%5D=5e94d5b63f557b001420bbe1%2C5e94d5b63f557b001420bbe2&filter%5BmodifiedBefore%5D=2021-01-01&filter%5BmodifiedSince%5D=2020-12-31&filter%5Bmonth%5D=march&filter%5BworkflowIds%5D=5e94d5b63f557b001420baa1%2C5e94d5b63f557b001420baa2&filter%5Byear%5D=2023&page%5Bcursor%5D=5e94d5b63f557b001420bbe3&page%5Bsize%5D=12000' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
dataArray of objects(ChecklistAnalyticsModel)

Array of Checklists

linksobject
Response
application/json
{
  "data": [
    { … }
  ],
  "links": {
    "self": "/api/v1/analytics/checklists?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3",
    "next": "/api/v1/analytics/checklists?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe6"
  }
}

Reconciliation Analytics

Operations

Depreciations

Operations

Amortization

Operations

Audit Trail

Operations

Transactions

Operations

Entities

Operations

Trial Balance

Operations

Tags

Operations

Chart Of Accounts

Operations

Info

Operations

Users

Operations

Folders

Operations