Skip to main content
Some intro here if necessary with context and feature links
Any notes

​
Query parameters

​
param_a
string
Description of what this query parameter does.
"param_a": "2025-01-01T00:00:00Z"
​
param_b
integer
default:1
Description for parameter B.
​
param_c
integer
default:100
Description for parameter C. Maximum is 1000.
​
param_d
string
default:"-id"
Description for parameter D. Prefix with - for descending order.
  • option_1 / -option_1: Option 1
  • option_2 / -option_2: Option 2
  • option_3 / -option_3: Option 3
  • option_4 / -option_4: Option 4

​
Path parameters

​
resource_id
string
required
The unique identifier of the resource to retrieve.

​
Request body

​
Section A

​
field_1
string | object | array
Description of field 1. Structure depends on field_3:
  • Type A: JSON string format
  • Type B: Text string or array format
  • Type C/D: Any JSON-serializable structure
"field_1": "[{\"key\":\"value\",\"data\":\"sample\"}]"

"field_1": "Sample text string"
​
field_2
string | object | array
Description of field 2. Structure depends on field_3.
"field_2": "{\"key\":\"value\",\"data\":\"response\"}"
​
field_3
string
default:"type_a"
Description of field 3. Determines how field_1 and field_2 are parsed.Supported types:
  • "type_a" - Type A records (default)
  • "type_b" - Type B records
  • "type_c" or "type_d" - Type C/D records
  • "type_e" or "type_f" - Type E/F records
  • "type_g" - Type G records
  • "type_h" - Custom type
If not specified, defaults to "type_a". For complete specifications of each type, see documentation.
​
field_4
string
Description of field 4. Optional but recommended for certain types.
"field_4": "sample-value-123"

​
Section B

​
field_5
object
Description of field 5 for the request.
​
sub_field_a
integer
Description of sub field A.
​
sub_field_b
integer
Description of sub field B.
​
sub_field_c
integer
Description of sub field C.
{
  "field_5": {
    "sub_field_a": 150,
    "sub_field_b": 85,
    "sub_field_c": 235
  }
}
​
field_6
float
Description of field 6. If not provided, will be calculated automatically.
​
field_7
float
Description of field 7 in seconds.
Previously called field_7_old. Both field names are supported for backward compatibility.
​
field_8
float
Description of field 8 in seconds. Useful for performance tracking.

​
Section C

​
field_9
object
Description of field 9 for analytics and filtering.
{
  "field_9": {
    "prop_1": "value_a",
    "prop_2": "v1.0.0",
    "prop_3": "tier_a"
  }
}
​
field_10
string
Description of field 10. Helps with tracking.
"field_10": "entity_123"
​
field_11
string
Description of field 11. Useful for grouping related records.
​
field_12
string
Same functionality as field_9, but indexed for faster querying.
"field_12": "ref_12345"

​
Section D

​
field_13
string
Description of field 13. Used to link multiple records together.
​
field_14
string
Description of field 14.
​
field_15
string
Description of field 15 within the group.

​
Body parameters

​
filters
object
The filters to be applied to the records.
If you want to filter your custom properties, add field_9__ prefix. For example, to filter my_property, use field_9__my_property.
{
  "filters": {
    "field_6": {
      "operator": "gt",
      "value": [10.0]
    },
    "field_9__prop_3": {
      "operator": "in",
      "value": ["tier_a", "tier_b"]
    }
  }
}
​
operator
string
Comparison operator for filtering. Default is "" (equal).
  • "" (empty string): Equal
  • "lt": Less than
  • "lte": Less than or equal
  • "gt": Greater than
  • "gte": Greater than or equal
  • "contains": Contains substring
  • "icontains": Case-insensitive contains
  • "startswith": Starts with
  • "endswith": Ends with
  • "in": Value in array
  • "not": Not equal
  • "isnull": Check if field is null

​
Advanced parameters

​
Feature 1

​
field_16
array
Description of field 16 array. Currently, only type A is supported.
​
type
string
required
The type of the item. Currently, only type_a is supported.
​
definition
object
required
Definition object containing name, description, and parameters.
"field_16": [
  {
    "type": "type_a",
    "definition": {
      "name": "action_name",
      "description": "Action description",
      "parameters": {
        "type": "object",
        "properties": {
          "param_x": {"type": "string"}
        },
        "required": ["param_x"]
      }
    }
  }
]
​
field_17
string | object
Description of field 17. Can be "none", "auto", or an object specifying a specific item.
"field_17": {
  "type": "type_a",
  "definition": {"name": "action_name"}
}

​
Feature 2

​
field_18
integer
default:200
Description of field 18 for the request. Default is 200.
All valid HTTP codes are supported: 200, 201, 400, 401, 403, 404, 429, 500, 502, 503, 504, etc.
​
field_19
string
Description of field 19 if the request failed. Default is empty string.
​
field_20
string | object
Description of field 20 that occurred during the request.

​
Feature 3

​
field_21
object
Description of field 21 behavior.
​
option_a
boolean
default:true
If false, the server immediately returns initialization status without waiting for completion.
{
  "field_21": {
    "option_a": true
  }
}

​
Response fields

Each record in the response includes:

​
Group A (All Record Types)

  • field_1 (string): Description of field 1 data
  • field_2 (string): Description of field 2 data
  • field_3 (string): Type of record ("type_a", "type_b", "type_c", etc.)

​
Compatibility notes

For field_3="type_a", "type_b", "type_c", or "type_d":
  • field_22 (array): Data array (extracted from field_1)
  • field_23 (object): Data object (extracted from field_2)
For other record types, type-specific fields are extracted based on the field_3. See documentation for details.

​
Group B

  • id (string): Unique identifier for the record
  • org_id (string): Organization’s unique ID
  • field_10 (string): Field 10 identifier
  • field_11 (string): Field 11 identifier

​
Group C

  • field_6 (float): Field 6 value in decimal
  • field_7 (float): Field 7 value in seconds
  • sub_field_a (integer): Sub field A units
  • sub_field_b (integer): Sub field B units
  • sub_field_total (integer): Total units
  • field_8 (float): Field 8 value in seconds
  • rate (float): Rate calculation

​
Group D

  • status (string): Record status ("success", "error")
  • field_18 (integer): HTTP code
  • field_19 (string): Error text if failed

​
Response

Returns the created record object with generated fields. 
{
  "id": "record_abc123",
  "status": "success",
  "field_6": 0.123,
  "timestamp": "2025-01-01T10:30:00Z",
  "org_id": "org_xyz789",
  "field_10": "entity_123"
}

import requests

url = "https://api.example.com/api/records/create/"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "field_3": "type_a",
    "field_4": "sample-value",
    "field_1": '[{"key":"value","data":"sample"}]',
    "field_2": '{"key":"value","data":"response"}',
    "field_5": {
        "sub_field_a": 10,
        "sub_field_b": 8,
        "sub_field_c": 18
    },
    "field_10": "entity_123",
    "field_7": 1.2,
    "field_9": {
        "prop_1": "value_a"
    }
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

{
  "id": "record_abc123",
  "unique_id": "record_abc123",
  "org_id": "org_xyz789",
  "field_10": "entity_123",
  "status": "success",
  "field_6": 0.123,
  "timestamp": "2025-01-01T10:30:00Z"
}