Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Core

get
Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

identityanyOptional

identity

data_sourceanyOptional

data_source

actoranyOptional

actor

locationanyOptional

location

labelsanyOptional

labels

cursoranyOptional

The pagination cursor value.

page_sizeanyOptional

Number of results to return per page.

filter_uuidanyOptional

UUID of filter to apply to results.

Responses
200Success
application/json
nextstring · uriOptional
previousstring · uriOptional
get/core/activity/
GET /core/activity/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "timestamp": "2026-01-01T00:00:00.000Z",
      "identity": "123e4567-e89b-12d3-a456-426614174000",
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "data_source": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "123e4567-e89b-12d3-a456-426614174000",
      "integration_unique": "text"
    }
  ]
}
get

View to return first and last activity timestamps.

Authorizations
AuthorizationstringRequired
Responses
200Success
application/json
get/core/activity/first_last/
GET /core/activity/first_last/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "first": {
    "timestamp": "2026-01-01T00:00:00.000Z"
  },
  "last": {
    "timestamp": "2026-01-01T00:00:00.000Z"
  }
}
get

Provides a view returning a list of actors with activity count intervals corresponding to the time range and interval count requested.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

filter_uuidanyOptional

UUID of filter to apply to results.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get/core/activity/statistics/actor/
GET /core/activity/statistics/actor/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "links": {
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "interval_duration": 1,
  "results": [
    {
      "actor": "123e4567-e89b-12d3-a456-426614174000",
      "counts": [
        {
          "timestamp": "2026-01-01T00:00:00.000Z",
          "count": 1
        }
      ]
    }
  ]
}
get

Provides a view returning overall activity stats for an organization or datasource. Used primarily for populated brush timeline data.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get/core/activity/statistics/combined/
GET /core/activity/statistics/combined/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "links": {
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "interval_duration": 1,
  "results": [
    {
      "timestamp": "2026-01-01T00:00:00.000Z",
      "count": 1
    }
  ]
}
get

Provides a view of activity statistics aggreagted by datasource.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get/core/activity/statistics/datasource/
GET /core/activity/statistics/datasource/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "links": {
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "interval_duration": 1,
  "results": [
    {
      "data_source": "123e4567-e89b-12d3-a456-426614174000",
      "counts": [
        {
          "timestamp": "2026-01-01T00:00:00.000Z",
          "count": 1
        }
      ]
    }
  ]
}
get

View for returning activity counts by label, bucketed by data source.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

data_sourceanyOptional

data_source

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

filter_uuidanyOptional

UUID of filter to apply to results.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get/core/activity/statistics/label/
GET /core/activity/statistics/label/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "links": {
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "interval_duration": 1,
  "results": [
    {
      "labels": [
        {
          "label": "123e4567-e89b-12d3-a456-426614174000",
          "counts": [
            {
              "timestamp": "2026-01-01T00:00:00.000Z",
              "count": 1
            }
          ],
          "total_count": 1
        }
      ],
      "data_source": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
get

Provides a view returning a list of locations with activity count intervals corresponding to the time range and interval count requested.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get/core/activity/statistics/location/
GET /core/activity/statistics/location/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "links": {
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "interval_duration": 1,
  "results": [
    {
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "counts": [
        {
          "timestamp": "2026-01-01T00:00:00.000Z",
          "count": 1
        }
      ]
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
activity_uuidstring · uuidRequired
get/core/activity/{uuid}/raw/
GET /core/activity/{uuid}/raw/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "activity_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "json_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
get/core/activity/{uuid}/raw/details/
GET /core/activity/{uuid}/raw/details/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "details": [
    {
      "field_name": "text",
      "value": "text"
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Query parameters
orderinganyOptional

Which field to use when ordering the results.

cursoranyOptional

The pagination cursor value.

page_sizeanyOptional

Number of results to return per page.

searchanyOptional

Search string

identitiesanyOptional

Filter by identity UUIDs (comma-separated)

Responses
200Success
application/json
nextstring · uriOptional
previousstring · uriOptional
get/core/actors/
GET /core/actors/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "id": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "given_name": "text",
      "family_name": "text",
      "organization": "123e4567-e89b-12d3-a456-426614174000",
      "identities": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
given_namestring · max: 255Optional
family_namestring · max: 255Optional
organizationstring · uuidRequired
identitiesstring · uuid[]Read-onlyOptional
get/core/actors/{uuid}/
GET /core/actors/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "given_name": "text",
  "family_name": "text",
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "identities": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
get
Authorizations
AuthorizationstringRequired
Query parameters
searchanyOptional

A search term.

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

min_countanyOptional

Return only event types with at least this many activities.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/event-type/
GET /core/event-type/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "id": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "integration_type": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "slug": "text",
      "discard": true,
      "linked_tags": [
        {
          "label": "text",
          "scope": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "id": 1
        }
      ]
    }
  ]
}
post
Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
integration_typestring · uuidRequired
namestring · min: 1 · max: 255Required
slugstring · min: 1 · max: 255Required
discardbooleanOptional
Responses
201Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
integration_typestring · uuidRequired
namestring · min: 1 · max: 255Required
slugstring · min: 1 · max: 255Required
discardbooleanOptional
post/core/event-type/
POST /core/event-type/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "integration_type": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "discard": true
}
201Success
{
  "id": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "integration_type": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "discard": true,
  "linked_tags": [
    {
      "label": "text",
      "scope": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "id": 1
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Query parameters
event_typesanyOptional

Filter by event type UUIDs (comma-separated)

uuidsanyOptional

Filter by event type UUIDs (comma-separated, alternative to event_types)

pageanyOptional

A page number within the paginated result set.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/event-type/descriptions/
GET /core/event-type/descriptions/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "event_type_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "description": "text"
    }
  ]
}
get

GET Endpoint for EventTypeDetails

Authorizations
AuthorizationstringRequired
Path parameters
event_type__uuidanyRequired
Responses
200Success
application/json
descriptionstring · min: 1Required
get/core/event-type/{event_type__uuid}/details/
GET /core/event-type/{event_type__uuid}/details/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "description": "text"
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
integration_typestring · uuidRequired
namestring · min: 1 · max: 255Required
slugstring · min: 1 · max: 255Required
discardbooleanOptional
get/core/event-type/{uuid}/
GET /core/event-type/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "integration_type": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "discard": true,
  "linked_tags": [
    {
      "label": "text",
      "scope": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "id": 1
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Query parameters
pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/filters/builtin/
GET /core/filters/builtin/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "filter_json": {
        "filter_name": "text",
        "filter_icon": "text",
        "filter_description": "text",
        "actors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "data_sources": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "event_types": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "locations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "labels": {
          "Application": {
            "ANY_ADDITIONAL_PROPERTY": "with"
          },
          "Context": {
            "ANY_ADDITIONAL_PROPERTY": "with"
          },
          "Access": {
            "ANY_ADDITIONAL_PROPERTY": "with"
          }
        },
        "date_range": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "highlight": [
        "text"
      ],
      "is_template": true
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
uuidstring · uuidRead-onlyOptional
highlightstring[]Optional
is_templatebooleanRead-onlyOptionalDefault: true
get/core/filters/builtin/{uuid}/
GET /core/filters/builtin/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "highlight": [
    "text"
  ],
  "is_template": true
}
get
Authorizations
AuthorizationstringRequired
Query parameters
pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

modeanyOptional

Specify what types of filters to fetch:

  • exclude_temporary: Fetch filters only manually saved filters
  • only_temporary: Fetch filters only temporary filters
  • all: Fetch all types of filters
Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/filters/user/
GET /core/filters/user/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "user": "123e4567-e89b-12d3-a456-426614174000",
      "last_user_editor": "123e4567-e89b-12d3-a456-426614174000",
      "filter_json": {
        "filter_name": "text",
        "filter_icon": "text",
        "filter_description": "text",
        "actors": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "data_sources": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "event_types": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "locations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "labels": {
          "Application": {
            "ANY_ADDITIONAL_PROPERTY": "with"
          },
          "Context": {
            "ANY_ADDITIONAL_PROPERTY": "with"
          },
          "Access": {
            "ANY_ADDITIONAL_PROPERTY": "with"
          }
        },
        "date_range": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "visibility": "user",
      "is_temporary": true,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}
post
Authorizations
AuthorizationstringRequired
Body
uuidstring · uuidRead-onlyOptional
userstring · uuidRead-onlyOptional
last_user_editorstring · uuidRead-onlyOptional
analystintegerOptional
last_analyst_editorintegerOptional
organizationintegerOptional
visibilitystring · enumOptionalPossible values:
is_temporarybooleanOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
Responses
201Success
application/json
uuidstring · uuidRequired
userstring · uuidRequired
last_user_editorstring · uuidRequired
visibilitystring · enumRequiredPossible values:
is_temporarybooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
post/core/filters/user/
POST /core/filters/user/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 567

{
  "analyst": 1,
  "last_analyst_editor": 1,
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "organization": 1,
  "visibility": "user",
  "is_temporary": true
}
201Success
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "last_user_editor": "123e4567-e89b-12d3-a456-426614174000",
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "visibility": "user",
  "is_temporary": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
uuidstring · uuidRequired
userstring · uuidRequired
last_user_editorstring · uuidRequired
visibilitystring · enumRequiredPossible values:
is_temporarybooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get/core/filters/user/{uuid}/
GET /core/filters/user/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "last_user_editor": "123e4567-e89b-12d3-a456-426614174000",
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "visibility": "user",
  "is_temporary": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}
put
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Body
uuidstring · uuidRead-onlyOptional
userstring · uuidRead-onlyOptional
last_user_editorstring · uuidRead-onlyOptional
analystintegerOptional
last_analyst_editorintegerOptional
organizationintegerOptional
visibilitystring · enumRequiredPossible values:
is_temporarybooleanOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
Responses
200Success
application/json
uuidstring · uuidRead-onlyOptional
userstring · uuidRead-onlyOptional
last_user_editorstring · uuidRead-onlyOptional
analystintegerOptional
last_analyst_editorintegerOptional
organizationintegerOptional
visibilitystring · enumRequiredPossible values:
is_temporarybooleanOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
put/core/filters/user/{uuid}/
PUT /core/filters/user/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 567

{
  "analyst": 1,
  "last_analyst_editor": 1,
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "organization": 1,
  "visibility": "user",
  "is_temporary": true
}
200Success
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "last_user_editor": "123e4567-e89b-12d3-a456-426614174000",
  "analyst": 1,
  "last_analyst_editor": 1,
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "organization": 1,
  "visibility": "user",
  "is_temporary": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}
delete
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
204Success
No content
delete/core/filters/user/{uuid}/
DELETE /core/filters/user/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
204Success
No content
patch
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Body
visibilitystring · enumOptionalPossible values:
Responses
200Success
application/json
uuidstring · uuidRequired
userstring · uuidRequired
last_user_editorstring · uuidRequired
visibilitystring · enumRequiredPossible values:
is_temporarybooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
patch/core/filters/user/{uuid}/
PATCH /core/filters/user/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 494

{
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "visibility": "user"
}
200Success
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "last_user_editor": "123e4567-e89b-12d3-a456-426614174000",
  "filter_json": {
    "filter_name": "text",
    "filter_icon": "text",
    "filter_description": "text",
    "actors": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "data_sources": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "event_types": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "locations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "Application": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Context": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      },
      "Access": {
        "ANY_ADDITIONAL_PROPERTY": "with"
      }
    },
    "date_range": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "visibility": "user",
  "is_temporary": true,
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}
get
Authorizations
AuthorizationstringRequired
Query parameters
uuidanyOptional

uuid

uuidsanyOptional

Filter by identity UUIDs (comma-separated)

searchanyOptional

A search term.

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/identity/
GET /core/identity/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "id": 1,
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "given_name": "text",
      "family_name": "text",
      "identifier": "name@gmail.com",
      "data_source": 1
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
given_namestring · max: 255Optional
family_namestring · max: 255Optional
identifierstring · email · min: 1Read-onlyOptional
data_sourceintegerOptional
get/core/identity/{uuid}/
GET /core/identity/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "id": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "given_name": "text",
  "family_name": "text",
  "identifier": "name@gmail.com",
  "data_source": 1
}
get
Authorizations
AuthorizationstringRequired
Query parameters
uuidanyOptional

uuid

uuidsanyOptional

Filter by location UUIDs (comma-separated)

locationsanyOptional

Filter by location UUIDs (comma-separated, alternative to uuids param)

searchanyOptional

A search term.

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/locations/
GET /core/locations/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "ip_address": "text",
      "city": "text",
      "region": "text",
      "country": "text",
      "country_code": "text",
      "latitude": 1,
      "longitude": 1,
      "category": "Unknown"
    }
  ]
}
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
uuidstring · uuidRead-onlyOptional
ip_addressstring · min: 1Read-onlyOptional
citystring · min: 1Read-onlyOptional
regionstring · min: 1Read-onlyOptional
countrystring · min: 1Read-onlyOptional
country_codestring · min: 1Read-onlyOptional
latitudenumberRead-onlyOptional
longitudenumberRead-onlyOptional
categorystring · enumRead-onlyOptionalPossible values:
get/core/locations/{uuid}/
GET /core/locations/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "ip_address": "text",
  "city": "text",
  "region": "text",
  "country": "text",
  "country_code": "text",
  "latitude": 1,
  "longitude": 1,
  "category": "Unknown"
}
patch
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Body
categorystring · enumRequiredPossible values:
Responses
200Success
application/json
categorystring · enumRequiredPossible values:
patch/core/locations/{uuid}/
PATCH /core/locations/{uuid}/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "category": "Unknown"
}
200Success
{
  "category": "Unknown"
}
get
Authorizations
AuthorizationstringRequired
Query parameters
pageanyOptional

A page number within the paginated result set.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get/core/queries/user/
GET /core/queries/user/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "filter": "text",
      "filter_json": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "is_temporary": true,
      "executed_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}
get

A view for providing the current build version.

Authorizations
AuthorizationstringRequired
Responses
200Success
application/json
versionstring · min: 1Required
get/core/version/
GET /core/version/ HTTP/1.1
Host: api.turngate.io/
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
  "version": "text"
}

Last updated