IXON DataExport API
The DataExport API from IXON — 1 operation(s) for dataexport.
OpenAPI Specification
openapi: 3.0.2
info:
contact:
name: IXON B.V.
url: https://www.ixon.cloud/
email: support@ixon.cloud
description: API for the IXON Cloud Platform
license:
name: All Rights Reserved
url: https://www.ixon.cloud/
title: IXON AccessRecoverList DataExport API
version: 0.1.294
servers:
- description: IXON Cloud platform server
url: https://portal.ixon.cloud:443/api/
tags:
- name: DataExport
paths:
/data-export:
post:
tags:
- DataExport
summary: DataExport
responses:
'201':
description: Success response
content:
application/json:
schema:
type: object
required:
- status
- type
- data
properties:
status:
type: string
default: success
nullable: false
type:
type: string
nullable: false
data:
type: object
nullable: true
4XX:
$ref: '#/components/responses/4XXErrorResponse'
parameters:
- $ref: '#/components/parameters/apiVersion'
- $ref: '#/components/parameters/apiApplication'
- $ref: '#/components/parameters/apiCompany'
- $ref: '#/components/parameters/apiBrandingOptional'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
start:
nullable: false
type: string
format: date-time
end:
nullable: false
type: string
format: date-time
timeZone:
maxLength: 255
minLength: 1
nullable: false
type: string
source:
nullable: false
type: object
properties:
publicId:
nullable: false
type: string
tags:
type: array
items:
nullable: false
type: object
properties:
id:
maximum: 4294967295
nullable: false
type: integer
format: int32
slug:
maxLength: 64
minLength: 1
nullable: false
pattern: ^[a-zA-Z0-9_\[\]-]+$
type: string
queries:
type: array
items:
nullable: false
type: object
properties:
ref:
maxLength: 255
minLength: 1
nullable: false
pattern: ^[^{}]*$
type: string
postAggr:
enum:
- count
- mean
- median
- mode
- spread
- sum
- first
- last
- max
- min
- raw
nullable: false
type: string
postTransform:
enum:
- difference
nullable: false
type: string
limit:
maximum: 5000
minimum: 1
nullable: false
type: integer
format: int32
step:
nullable: false
offset:
maximum: 9223372036854776000
nullable: false
type: integer
format: int32
factor:
nullable: false
type: string
operator:
enum:
- '*'
- /
- +
- '-'
nullable: false
type: string
decimals:
maximum: 7
nullable: false
type: integer
format: int32
extendedBoundary:
nullable: false
type: boolean
order:
enum:
- asc
- desc
nullable: false
type: string
required:
- source
- tags
security:
- bearerToken: []
components:
parameters:
apiApplication:
required: true
description: Get your Application ID via support@ixon.cloud
name: Api-Application
in: header
schema:
type: string
pattern: ^[0-9a-zA-Z]{12}$
apiVersion:
required: true
description: Version of the API to use
name: Api-Version
in: header
schema:
type: integer
format: int32
enum:
- 2
apiBrandingOptional:
required: false
description: Domain that provides the branding
name: Api-Branding
in: header
schema:
type: string
pattern: .+(\..[^.]+)
apiCompany:
required: true
description: PublicId of the company
name: Api-Company
in: header
schema:
type: string
pattern: ^(\d{4}-){4}\d{4}$
responses:
4XXErrorResponse:
description: 4XX error response
content:
application/json:
schema:
type: object
required:
- status
- type
- data
properties:
status:
type: string
default: error
nullable: false
type:
type: string
default: Error
nullable: false
data:
nullable: false
type: array
items:
$ref: '#/components/schemas/4XXErrorSchema'
schemas:
4XXErrorSchema:
type: object
properties:
message:
nullable: false
type: string
propertyName:
nullable: true
type: string
listIndex:
nullable: true
type: integer
format: int32
required:
- message
securitySchemes:
bearerToken:
type: http
description: Bearer token created by the endpoint "POST AccessTokenList"
scheme: bearer
x-samples-languages:
- curl
- ruby
- javascript
- python
- powershell