Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Gremlin Reports.security API
version: '1.0'
contact:
name: Gremlin Support
email: support@gremlin.com
license:
name: Gremlin License
url: https://www.gremlin.com/license_2017_03_24
termsOfService: https://www.gremlin.com/terms_of_service_2017_03_24
description: 'Operations tagged reports.security across 2 of this provider''s published API definitions: gremlin-openapi.json, gremlin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /v1
- url: https://api.gremlin.com/v1
description: Gremlin API v1
tags:
- name: reports.security
description: Endpoints for receiving access and event logs
paths:
/reports/security/access:
get:
tags:
- reports.security
summary: Loads the Access Summary for the specified company in the time period requested…
description: 'COMPANY_OWNER and COMPANY_ADMIN users only
Requires the privilege `SECURITY_REPORTS_READ`'
operationId: accessSummary
parameters:
- name: start
in: query
description: Start time in format 'yyyy-mm-ddThh:mm:ss.sssZ'
required: true
schema:
type: string
format: date-time
- name: end
in: query
description: End time in format 'yyyy-mm-ddThh:mm:ss.sssZ'
required: true
schema:
type: string
format: date-time
responses:
default:
description: default response
content:
application/json: {}
text/plain: {}
'403':
description: 'User requires privilege: SECURITY_REPORTS_READ'
'401':
description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
security:
- privilege:
- SECURITY_REPORTS_READ
servers:
- url: /v1
/reports/security/event:
get:
tags:
- reports.security
summary: Loads the Experiment Summary for the specified company in the time period…
description: 'COMPANY_OWNER and COMPANY_ADMIN users only
Requires the privilege `SECURITY_REPORTS_READ`'
operationId: eventSummary
parameters:
- name: start
in: query
description: Start time in format 'yyyy-mm-ddThh:mm:ss.sssZ'
required: true
schema:
type: string
format: date-time
- name: end
in: query
description: End time in format 'yyyy-mm-ddThh:mm:ss.sssZ'
required: true
schema:
type: string
format: date-time
responses:
default:
description: default response
content:
application/json: {}
text/plain: {}
'403':
description: 'User requires privilege: SECURITY_REPORTS_READ'
'401':
description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
security:
- privilege:
- SECURITY_REPORTS_READ
servers:
- url: /v1
/reports/security/event/delegate:
get:
tags:
- reports.security
summary: Loads the Experiment Summary for the specified company in the time period…
description: 'COMPANY_OWNER and COMPANY_ADMIN users only
Requires the privilege `SECURITY_REPORTS_READ`'
operationId: eventSummaryDelegate
parameters:
- name: start
in: query
description: Start time in format 'yyyy-mm-ddThh:mm:ss.sssZ'
required: true
schema:
type: string
format: date-time
- name: end
in: query
description: End time in format 'yyyy-mm-ddThh:mm:ss.sssZ'
required: true
schema:
type: string
format: date-time
responses:
default:
description: default response
content:
application/json: {}
text/plain: {}
'403':
description: 'User requires privilege: SECURITY_REPORTS_READ'
'401':
description: Authorization header missing or malformed. Please provide proper credentials in the authorization header.
security:
- privilege:
- SECURITY_REPORTS_READ
servers:
- url: /v1
x-refined-from:
- gremlin-openapi.json
- gremlin-openapi.yml