Analytics REST API documentation version v1
https://localhost:8443/analytics/api/{version}
- version: required (v1)
/charts
The chart endpoint.
post
post /charts
Body
Media type: application/json
Type: object
"A request to provide a chart resource that is constructed based on the
request's content. Contains the query and chart configurations, the client
time zone and a timeout value, after which the request is cancelled.
Example:
{
"query_configuration": {
"primary_entity": "JOB",
"time_frame": {
"between": {
"start": "2015-01-01",
"end": "2016-06-30"
}
},
"query_tree_root": {
"leaves": [
{
"query_criterion": {
"generic": {
"operator": "CONTAINS",
"expressions": [
{
"label": "TEST",
"value": "TEST"
}
],
"attribute_value": "AGENT_NAME"
}
}
}
],
"branches": [
],
"query_tree_root_operator": "ANY"
}
},
"chart_configuration": {
"type": "TABLE",
"event": "END_TIME",
"sort_attribute": "END_TIME",
"sort_order": "ASCENDING",
"offset": 0,
"limit": 1000
},
"time_zone": "UTC",
"timeout": 10000
}"
The following properties are mandatory to be set:
- query_configuration:
Type: QueryConfiguration
"The main query configuration. Defines for which primary entity the query
is to be executed, in which time frame and what query criteria are to be
used. Example:
{
"primary_entity": "SERVICE_FULFILLMENT",
"time_frame": {
"between": {
"start": "2015-01-01",
"end": "2016-06-30"
}
},
"query_tree_root": {
"leaves" : [ ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_STATUS_CODE",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "VIOLATED",
"value" : "VIOLATED"
} ]
}
}
} ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_CLIENT",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "100",
"value" : 100
} ]
}
}
}, {
"query_criterion" : {
"generic" : {
"attribute_value" : "DAY_OF_MONTH",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "1",
"value" : 1
} ]
}
}
} ],
"branches" : [ ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
}
}"
Sub Properties:
- primary_entity: Type: PrimaryEntity, Enumeration: [JOB,SERVICE_FULFILLMENT,WORKFLOW,APPLICATION_DEPLOYMENT] "Primary entities."
- time_frame:
Type: TimeFrame
"Defines the time frame that contains the data for the chart. Can be defined
as:
- last full day, month etc. (absolute calendar date range),
- between the 10th and 15th of January (specific start and end time),
- within last 7 days (relative to the current date)."
Sub Properties:
- last_full (optional):
Type: TimeFrameFull
"A full calendar time unit (e.g. day, week, month etc.). The start and end
dates are adjusted to guarantee calendar time unit integrity (e.g. if last
full week is selected on a Thursday, Monday to Sunday from the week before
are set as the start and end date)."
Sub Properties:
- time_unit: Type: TimeFrameUnit, Enumeration: [DAY,WEEK,MONTH,YEAR] "Unit of the time frame setting."
- within_last (optional):
Type: TimeFrameWithinLast
"A specified amount of time units leading up to the current date. A time
frame within 2 weeks before 2015-12-03 will result in a time frame from
2015-11-19 until 2015-12-03."
Sub Properties:
- amount: Type: integer
- time_unit: Type: TimeFrameUnit, Enumeration: [DAY,WEEK,MONTH,YEAR] "Unit of the time frame setting."
- between (optional):
Type: TimeFrameBetween
"A fixed time frame between two fixed time points (start time, end time)."
Sub Properties:
- start: Type: date-only
- end: Type: date-only
- last_full (optional):
Type: TimeFrameFull
"A full calendar time unit (e.g. day, week, month etc.). The start and end
dates are adjusted to guarantee calendar time unit integrity (e.g. if last
full week is selected on a Thursday, Monday to Sunday from the week before
are set as the start and end date)."
Sub Properties:
- logical_date (optional): Type: datetime
- query_tree_root:
Type: QueryTreeNode
"A tree node containing leaves and branches that form a query tree. Maximum
nesting limit is set to 5. Branches can contain leaves and an operator
applied to all leaves. The outermost node is called the root. Example:
{
"leaves" : [ ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_STATUS_CODE",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "VIOLATED",
"value" : "VIOLATED"
} ]
}
}
} ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_CLIENT",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "100",
"value" : 100
} ]
}
}
}, {
"query_criterion" : {
"generic" : {
"attribute_value" : "DAY_OF_MONTH",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "1",
"value" : 1
} ]
}
}
} ],
"branches" : [ ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
}"
Sub Properties:
- leaves: Type: array
- branches: Type: array
- query_tree_root_operator: Type: string
- chart_configuration:
Type: ChartConfiguration
"A chart configuration defining the chart type and corresponding settings.
Example:
{
"type": "DEVIATION",
"categorization": "OBJECT_NAME",
"event": "END_TIME",
"aggregate_attribute": "RUN_TIME",
"sampling_coefficient": 0.8,
"threshold": 100.0,
"include_negative_values": false,
"include_positive_values": true
}"
Sub Properties:
- type: Type: ChartType, Enumeration: [PIE_DONUT,BAR_COLUMN,TABLE,TIME_SERIES,GROUPED_TABLE,DEVIATION] "Chart type."
- event: Type: Event, Enumeration: [START_TIME,END_TIME,SLO_DETECT_TIME,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_ACTUAL_FROM, ARA_EXECUTION_ACTUAL_TO] "Events that define the lifecycle of a primary entity."
- aggregate (optional): Type: Aggregate, Enumeration: [COUNT,SUM,AVERAGE] "Type of aggregate function."
- aggregate_attribute (optional): Type: AttributeValue, Enumeration: [HOUR_OF_DAY,DAY_OF_MONTH,AGENT_NAME,AGENT_TYPE,ARCHIVE_KEY1,ARCHIVE_KEY2,CLIENT,END_TIME, OBJECT_NAME,OBJECT_TITLE,OBJECT_TYPE,QUEUE,START_TIME,STATUS_CODE,STATUS_CODE_GROUP, JOB_ACTIVE,RUN_TIME,ERT,SLO_DETECT_TIME,SLO_NAME,SERVICE_NAME,SERVICE_TYPE,SERVICE_RUN_ID, SLO_STATUS_CODE,SERVICE_VIOLATION_REASON,SLO_CLIENT,ARA_CLIENT,ARA_EXECUTION_ACTUAL_DURATION, ARA_EXECUTION_DELAY,ARA_EXECUTION_ACTUAL_FROM,ARA_EXECUTION_ACTUAL_TO,ARA_EXECUTION_ACTIVE, ARA_EXECUTION_ARCHIVED,ARA_EXECUTION_INSTALL_MODE,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_STATUS, ARA_EXECUTION_OWNER_NAME,ARA_EXECUTION_NEEDS_MANUAL_START,ARA_EXECUTION_MANUAL_CONFIRMER_NAME, ARA_WORKFLOW_ARCHIVED,ARA_WORKFLOW_FOLDER_NAME,ARA_WORKFLOW_OWNER_NAME,ARA_WORKFLOW_NAME, ARA_APPLICATION_NAME,ARA_APPLICATION_CUSTOM_TYPE,ARA_APPLICATION_OWNER_NAME,ARA_APPLICATION_FOLDER_NAME, ARA_APPLICATION_ARCHIVED,ARA_DEPLOYMENT_PACKAGE_NAME,ARA_DEPLOYMENT_PACKAGE_BASE_TYPE, ARA_DEPLOYMENT_PACKAGE_CUSTOM_TYPE,ARA_DEPLOYMENT_PACKAGE_STATUS,ARA_DEPLOYMENT_PACKAGE_IS_CLOSED, ARA_DEPLOYMENT_PACKAGE_MILESTONE,ARA_DEPLOYMENT_PACKAGE_RELEASE_NAME,ARA_DEPLOYMENT_PACKAGE_RELEASE_STATUS, ARA_DEPLOYMENT_PACKAGE_RELEASE_CUSTOM_TYPE,ARA_ENVIRONMENT_NAME,ARA_ENVIRONMENT_CUSTOM_TYPE, ARA_ENVIRONMENT_STATUS,ARA_DEPLOYMENT_PROFILE_NAME] "Superset of attributes for all primary entities."
- categorization (optional): Type: AttributeValue, Enumeration: [HOUR_OF_DAY,DAY_OF_MONTH,AGENT_NAME,AGENT_TYPE,ARCHIVE_KEY1,ARCHIVE_KEY2,CLIENT,END_TIME, OBJECT_NAME,OBJECT_TITLE,OBJECT_TYPE,QUEUE,START_TIME,STATUS_CODE,STATUS_CODE_GROUP, JOB_ACTIVE,RUN_TIME,ERT,SLO_DETECT_TIME,SLO_NAME,SERVICE_NAME,SERVICE_TYPE,SERVICE_RUN_ID, SLO_STATUS_CODE,SERVICE_VIOLATION_REASON,SLO_CLIENT,ARA_CLIENT,ARA_EXECUTION_ACTUAL_DURATION, ARA_EXECUTION_DELAY,ARA_EXECUTION_ACTUAL_FROM,ARA_EXECUTION_ACTUAL_TO,ARA_EXECUTION_ACTIVE, ARA_EXECUTION_ARCHIVED,ARA_EXECUTION_INSTALL_MODE,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_STATUS, ARA_EXECUTION_OWNER_NAME,ARA_EXECUTION_NEEDS_MANUAL_START,ARA_EXECUTION_MANUAL_CONFIRMER_NAME, ARA_WORKFLOW_ARCHIVED,ARA_WORKFLOW_FOLDER_NAME,ARA_WORKFLOW_OWNER_NAME,ARA_WORKFLOW_NAME, ARA_APPLICATION_NAME,ARA_APPLICATION_CUSTOM_TYPE,ARA_APPLICATION_OWNER_NAME,ARA_APPLICATION_FOLDER_NAME, ARA_APPLICATION_ARCHIVED,ARA_DEPLOYMENT_PACKAGE_NAME,ARA_DEPLOYMENT_PACKAGE_BASE_TYPE, ARA_DEPLOYMENT_PACKAGE_CUSTOM_TYPE,ARA_DEPLOYMENT_PACKAGE_STATUS,ARA_DEPLOYMENT_PACKAGE_IS_CLOSED, ARA_DEPLOYMENT_PACKAGE_MILESTONE,ARA_DEPLOYMENT_PACKAGE_RELEASE_NAME,ARA_DEPLOYMENT_PACKAGE_RELEASE_STATUS, ARA_DEPLOYMENT_PACKAGE_RELEASE_CUSTOM_TYPE,ARA_ENVIRONMENT_NAME,ARA_ENVIRONMENT_CUSTOM_TYPE, ARA_ENVIRONMENT_STATUS,ARA_DEPLOYMENT_PROFILE_NAME] "Superset of attributes for all primary entities."
- grouping_limit (optional): Type: integer
- grouping_order (optional): Type: Order, Enumeration: [DESCENDING,ASCENDING] "Sorting order."
- granularity (optional): Type: Granularity, Enumeration: [HOUR,DAY,WEEK,MONTH,YEAR] "Time granularity used when aggregating data."
- sort_attribute (optional): Type: AttributeValue, Enumeration: [HOUR_OF_DAY,DAY_OF_MONTH,AGENT_NAME,AGENT_TYPE,ARCHIVE_KEY1,ARCHIVE_KEY2,CLIENT,END_TIME, OBJECT_NAME,OBJECT_TITLE,OBJECT_TYPE,QUEUE,START_TIME,STATUS_CODE,STATUS_CODE_GROUP, JOB_ACTIVE,RUN_TIME,ERT,SLO_DETECT_TIME,SLO_NAME,SERVICE_NAME,SERVICE_TYPE,SERVICE_RUN_ID, SLO_STATUS_CODE,SERVICE_VIOLATION_REASON,SLO_CLIENT,ARA_CLIENT,ARA_EXECUTION_ACTUAL_DURATION, ARA_EXECUTION_DELAY,ARA_EXECUTION_ACTUAL_FROM,ARA_EXECUTION_ACTUAL_TO,ARA_EXECUTION_ACTIVE, ARA_EXECUTION_ARCHIVED,ARA_EXECUTION_INSTALL_MODE,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_STATUS, ARA_EXECUTION_OWNER_NAME,ARA_EXECUTION_NEEDS_MANUAL_START,ARA_EXECUTION_MANUAL_CONFIRMER_NAME, ARA_WORKFLOW_ARCHIVED,ARA_WORKFLOW_FOLDER_NAME,ARA_WORKFLOW_OWNER_NAME,ARA_WORKFLOW_NAME, ARA_APPLICATION_NAME,ARA_APPLICATION_CUSTOM_TYPE,ARA_APPLICATION_OWNER_NAME,ARA_APPLICATION_FOLDER_NAME, ARA_APPLICATION_ARCHIVED,ARA_DEPLOYMENT_PACKAGE_NAME,ARA_DEPLOYMENT_PACKAGE_BASE_TYPE, ARA_DEPLOYMENT_PACKAGE_CUSTOM_TYPE,ARA_DEPLOYMENT_PACKAGE_STATUS,ARA_DEPLOYMENT_PACKAGE_IS_CLOSED, ARA_DEPLOYMENT_PACKAGE_MILESTONE,ARA_DEPLOYMENT_PACKAGE_RELEASE_NAME,ARA_DEPLOYMENT_PACKAGE_RELEASE_STATUS, ARA_DEPLOYMENT_PACKAGE_RELEASE_CUSTOM_TYPE,ARA_ENVIRONMENT_NAME,ARA_ENVIRONMENT_CUSTOM_TYPE, ARA_ENVIRONMENT_STATUS,ARA_DEPLOYMENT_PROFILE_NAME] "Superset of attributes for all primary entities."
- sort_order (optional): Type: Order, Enumeration: [DESCENDING,ASCENDING] "Sorting order."
- offset (optional): Type: integer
- limit (optional): Type: integer
- sampling_coefficient (optional): Type: number
- threshold (optional): Type: number
- include_negative_values (optional): Type: boolean
- include_positive_values (optional): Type: boolean
- time_zone: Type: string
- timeout: Type: integer
Example:
{
"query_configuration" : {
"primary_entity" : "JOB",
"time_frame" : {
"last_full" : {
"time_unit" : "WEEK"
}
},
"query_tree_root" : {
"leaves" : [ ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "AGENT_TYPE",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "UNIX",
"value" : "UNIX"
} ]
}
}
} ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "HOUR_OF_DAY",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "9",
"value" : 9
} ]
}
}
}, {
"query_criterion" : {
"generic" : {
"attribute_value" : "HOUR_OF_DAY",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "16",
"value" : 16
} ]
}
}
} ],
"branches" : [ ],
"query_tree_root_operator" : "ANY"
} ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
}
},
"chart_configuration" : {
"type" : "PIE_DONUT",
"event" : "END_TIME",
"aggregate" : "COUNT",
"categorization" : "STATUS_CODE_GROUP",
"grouping_limit" : 15,
"grouping_order" : "DESCENDING"
},
"time_zone" : "UTC",
"timeout" : 300
}
HTTP status code 200
Body
Media type: application/json
Type: ChartResponse
The following properties are returned:
- chart_request:
Type: ChartRequest
"A request to provide a chart resource that is constructed based on the
request's content. Contains the query and chart configurations, the client
time zone and a timeout value, after which the request is cancelled.
Example:
{
"query_configuration": {
"primary_entity": "JOB",
"time_frame": {
"between": {
"start": "2015-01-01",
"end": "2016-06-30"
}
},
"query_tree_root": {
"leaves": [
{
"query_criterion": {
"generic": {
"operator": "CONTAINS",
"expressions": [
{
"label": "TEST",
"value": "TEST"
}
],
"attribute_value": "AGENT_NAME"
}
}
}
],
"branches": [
],
"query_tree_root_operator": "ANY"
}
},
"chart_configuration": {
"type": "TABLE",
"event": "END_TIME",
"sort_attribute": "END_TIME",
"sort_order": "ASCENDING",
"offset": 0,
"limit": 1000
},
"time_zone": "UTC",
"timeout": 10000
}"
Sub Properties:
- query_configuration:
Type: QueryConfiguration
"The main query configuration. Defines for which primary entity the query
is to be executed, in which time frame and what query criteria are to be
used. Example:
{
"primary_entity": "SERVICE_FULFILLMENT",
"time_frame": {
"between": {
"start": "2015-01-01",
"end": "2016-06-30"
}
},
"query_tree_root": {
"leaves" : [ ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_STATUS_CODE",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "VIOLATED",
"value" : "VIOLATED"
} ]
}
}
} ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_CLIENT",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "100",
"value" : 100
} ]
}
}
}, {
"query_criterion" : {
"generic" : {
"attribute_value" : "DAY_OF_MONTH",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "1",
"value" : 1
} ]
}
}
} ],
"branches" : [ ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
}
}"
Sub Properties:
- primary_entity: Type: PrimaryEntity, Enumeration: [JOB,SERVICE_FULFILLMENT,WORKFLOW,APPLICATION_DEPLOYMENT] "Primary entities."
- time_frame:
Type: TimeFrame
"Defines the time frame that contains the data for the chart. Can be defined
as:
- last full day, month etc. (absolute calendar date range),
- between the 10th and 15th of January (specific start and end time),
- within last 7 days (relative to the current date)."
Sub Properties:
- last_full (optional):
Type: TimeFrameFull
"A full calendar time unit (e.g. day, week, month etc.). The start and end
dates are adjusted to guarantee calendar time unit integrity (e.g. if last
full week is selected on a Thursday, Monday to Sunday from the week before
are set as the start and end date)."
Sub Properties:
- time_unit: Type: TimeFrameUnit, Enumeration: [DAY,WEEK,MONTH,YEAR] "Unit of the time frame setting."
- within_last (optional):
Type: TimeFrameWithinLast
"A specified amount of time units leading up to the current date. A time
frame within 2 weeks before 2015-12-03 will result in a time frame from
2015-11-19 until 2015-12-03."
Sub Properties:
- amount: Type: integer
- time_unit: Type: TimeFrameUnit, Enumeration: [DAY,WEEK,MONTH,YEAR] "Unit of the time frame setting."
- between (optional):
Type: TimeFrameBetween
"A fixed time frame between two fixed time points (start time, end time)."
Sub Properties:
- start: Type: date-only
- end: Type: date-only
- last_full (optional):
Type: TimeFrameFull
"A full calendar time unit (e.g. day, week, month etc.). The start and end
dates are adjusted to guarantee calendar time unit integrity (e.g. if last
full week is selected on a Thursday, Monday to Sunday from the week before
are set as the start and end date)."
Sub Properties:
- logical_date (optional): Type: datetime
- query_tree_root:
Type: QueryTreeNode
"A tree node containing leaves and branches that form a query tree. Maximum
nesting limit is set to 5. Branches can contain leaves and an operator
applied to all leaves. The outermost node is called the root. Example:
{
"leaves" : [ ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_STATUS_CODE",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "VIOLATED",
"value" : "VIOLATED"
} ]
}
}
} ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_CLIENT",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "100",
"value" : 100
} ]
}
}
}, {
"query_criterion" : {
"generic" : {
"attribute_value" : "DAY_OF_MONTH",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "1",
"value" : 1
} ]
}
}
} ],
"branches" : [ ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
}"
Sub Properties:
- leaves: Type: array
- branches: Type: array
- query_tree_root_operator: Type: string
- chart_configuration:
Type: ChartConfiguration
"A chart configuration defining the chart type and corresponding settings.
Example:
{
"type": "DEVIATION",
"categorization": "OBJECT_NAME",
"event": "END_TIME",
"aggregate_attribute": "RUN_TIME",
"sampling_coefficient": 0.8,
"threshold": 100.0,
"include_negative_values": false,
"include_positive_values": true
}"
Sub Properties:
- type: Type: ChartType, Enumeration: [PIE_DONUT,BAR_COLUMN,TABLE,TIME_SERIES,GROUPED_TABLE,DEVIATION] "Chart type."
- event: Type: Event, Enumeration: [START_TIME,END_TIME,SLO_DETECT_TIME,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_ACTUAL_FROM, ARA_EXECUTION_ACTUAL_TO] "Events that define the lifecycle of a primary entity."
- aggregate (optional): Type: Aggregate, Enumeration: [COUNT,SUM,AVERAGE] "Type of aggregate function."
- aggregate_attribute (optional): Type: AttributeValue, Enumeration: [HOUR_OF_DAY,DAY_OF_MONTH,AGENT_NAME,AGENT_TYPE,ARCHIVE_KEY1,ARCHIVE_KEY2,CLIENT,END_TIME, OBJECT_NAME,OBJECT_TITLE,OBJECT_TYPE,QUEUE,START_TIME,STATUS_CODE,STATUS_CODE_GROUP, JOB_ACTIVE,RUN_TIME,ERT,SLO_DETECT_TIME,SLO_NAME,SERVICE_NAME,SERVICE_TYPE,SERVICE_RUN_ID, SLO_STATUS_CODE,SERVICE_VIOLATION_REASON,SLO_CLIENT,ARA_CLIENT,ARA_EXECUTION_ACTUAL_DURATION, ARA_EXECUTION_DELAY,ARA_EXECUTION_ACTUAL_FROM,ARA_EXECUTION_ACTUAL_TO,ARA_EXECUTION_ACTIVE, ARA_EXECUTION_ARCHIVED,ARA_EXECUTION_INSTALL_MODE,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_STATUS, ARA_EXECUTION_OWNER_NAME,ARA_EXECUTION_NEEDS_MANUAL_START,ARA_EXECUTION_MANUAL_CONFIRMER_NAME, ARA_WORKFLOW_ARCHIVED,ARA_WORKFLOW_FOLDER_NAME,ARA_WORKFLOW_OWNER_NAME,ARA_WORKFLOW_NAME, ARA_APPLICATION_NAME,ARA_APPLICATION_CUSTOM_TYPE,ARA_APPLICATION_OWNER_NAME,ARA_APPLICATION_FOLDER_NAME, ARA_APPLICATION_ARCHIVED,ARA_DEPLOYMENT_PACKAGE_NAME,ARA_DEPLOYMENT_PACKAGE_BASE_TYPE, ARA_DEPLOYMENT_PACKAGE_CUSTOM_TYPE,ARA_DEPLOYMENT_PACKAGE_STATUS,ARA_DEPLOYMENT_PACKAGE_IS_CLOSED, ARA_DEPLOYMENT_PACKAGE_MILESTONE,ARA_DEPLOYMENT_PACKAGE_RELEASE_NAME,ARA_DEPLOYMENT_PACKAGE_RELEASE_STATUS, ARA_DEPLOYMENT_PACKAGE_RELEASE_CUSTOM_TYPE,ARA_ENVIRONMENT_NAME,ARA_ENVIRONMENT_CUSTOM_TYPE, ARA_ENVIRONMENT_STATUS,ARA_DEPLOYMENT_PROFILE_NAME] "Superset of attributes for all primary entities."
- categorization (optional): Type: AttributeValue, Enumeration: [HOUR_OF_DAY,DAY_OF_MONTH,AGENT_NAME,AGENT_TYPE,ARCHIVE_KEY1,ARCHIVE_KEY2,CLIENT,END_TIME, OBJECT_NAME,OBJECT_TITLE,OBJECT_TYPE,QUEUE,START_TIME,STATUS_CODE,STATUS_CODE_GROUP, JOB_ACTIVE,RUN_TIME,ERT,SLO_DETECT_TIME,SLO_NAME,SERVICE_NAME,SERVICE_TYPE,SERVICE_RUN_ID, SLO_STATUS_CODE,SERVICE_VIOLATION_REASON,SLO_CLIENT,ARA_CLIENT,ARA_EXECUTION_ACTUAL_DURATION, ARA_EXECUTION_DELAY,ARA_EXECUTION_ACTUAL_FROM,ARA_EXECUTION_ACTUAL_TO,ARA_EXECUTION_ACTIVE, ARA_EXECUTION_ARCHIVED,ARA_EXECUTION_INSTALL_MODE,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_STATUS, ARA_EXECUTION_OWNER_NAME,ARA_EXECUTION_NEEDS_MANUAL_START,ARA_EXECUTION_MANUAL_CONFIRMER_NAME, ARA_WORKFLOW_ARCHIVED,ARA_WORKFLOW_FOLDER_NAME,ARA_WORKFLOW_OWNER_NAME,ARA_WORKFLOW_NAME, ARA_APPLICATION_NAME,ARA_APPLICATION_CUSTOM_TYPE,ARA_APPLICATION_OWNER_NAME,ARA_APPLICATION_FOLDER_NAME, ARA_APPLICATION_ARCHIVED,ARA_DEPLOYMENT_PACKAGE_NAME,ARA_DEPLOYMENT_PACKAGE_BASE_TYPE, ARA_DEPLOYMENT_PACKAGE_CUSTOM_TYPE,ARA_DEPLOYMENT_PACKAGE_STATUS,ARA_DEPLOYMENT_PACKAGE_IS_CLOSED, ARA_DEPLOYMENT_PACKAGE_MILESTONE,ARA_DEPLOYMENT_PACKAGE_RELEASE_NAME,ARA_DEPLOYMENT_PACKAGE_RELEASE_STATUS, ARA_DEPLOYMENT_PACKAGE_RELEASE_CUSTOM_TYPE,ARA_ENVIRONMENT_NAME,ARA_ENVIRONMENT_CUSTOM_TYPE, ARA_ENVIRONMENT_STATUS,ARA_DEPLOYMENT_PROFILE_NAME] "Superset of attributes for all primary entities."
- grouping_limit (optional): Type: integer
- grouping_order (optional): Type: Order, Enumeration: [DESCENDING,ASCENDING] "Sorting order."
- granularity (optional): Type: Granularity, Enumeration: [HOUR,DAY,WEEK,MONTH,YEAR] "Time granularity used when aggregating data."
- sort_attribute (optional): Type: AttributeValue, Enumeration: [HOUR_OF_DAY,DAY_OF_MONTH,AGENT_NAME,AGENT_TYPE,ARCHIVE_KEY1,ARCHIVE_KEY2,CLIENT,END_TIME, OBJECT_NAME,OBJECT_TITLE,OBJECT_TYPE,QUEUE,START_TIME,STATUS_CODE,STATUS_CODE_GROUP, JOB_ACTIVE,RUN_TIME,ERT,SLO_DETECT_TIME,SLO_NAME,SERVICE_NAME,SERVICE_TYPE,SERVICE_RUN_ID, SLO_STATUS_CODE,SERVICE_VIOLATION_REASON,SLO_CLIENT,ARA_CLIENT,ARA_EXECUTION_ACTUAL_DURATION, ARA_EXECUTION_DELAY,ARA_EXECUTION_ACTUAL_FROM,ARA_EXECUTION_ACTUAL_TO,ARA_EXECUTION_ACTIVE, ARA_EXECUTION_ARCHIVED,ARA_EXECUTION_INSTALL_MODE,ARA_EXECUTION_PLANNED_FROM,ARA_EXECUTION_STATUS, ARA_EXECUTION_OWNER_NAME,ARA_EXECUTION_NEEDS_MANUAL_START,ARA_EXECUTION_MANUAL_CONFIRMER_NAME, ARA_WORKFLOW_ARCHIVED,ARA_WORKFLOW_FOLDER_NAME,ARA_WORKFLOW_OWNER_NAME,ARA_WORKFLOW_NAME, ARA_APPLICATION_NAME,ARA_APPLICATION_CUSTOM_TYPE,ARA_APPLICATION_OWNER_NAME,ARA_APPLICATION_FOLDER_NAME, ARA_APPLICATION_ARCHIVED,ARA_DEPLOYMENT_PACKAGE_NAME,ARA_DEPLOYMENT_PACKAGE_BASE_TYPE, ARA_DEPLOYMENT_PACKAGE_CUSTOM_TYPE,ARA_DEPLOYMENT_PACKAGE_STATUS,ARA_DEPLOYMENT_PACKAGE_IS_CLOSED, ARA_DEPLOYMENT_PACKAGE_MILESTONE,ARA_DEPLOYMENT_PACKAGE_RELEASE_NAME,ARA_DEPLOYMENT_PACKAGE_RELEASE_STATUS, ARA_DEPLOYMENT_PACKAGE_RELEASE_CUSTOM_TYPE,ARA_ENVIRONMENT_NAME,ARA_ENVIRONMENT_CUSTOM_TYPE, ARA_ENVIRONMENT_STATUS,ARA_DEPLOYMENT_PROFILE_NAME] "Superset of attributes for all primary entities."
- sort_order (optional): Type: Order, Enumeration: [DESCENDING,ASCENDING] "Sorting order."
- offset (optional): Type: integer
- limit (optional): Type: integer
- sampling_coefficient (optional): Type: number
- threshold (optional): Type: number
- include_negative_values (optional): Type: boolean
- include_positive_values (optional): Type: boolean
- time_zone: Type: string
- timeout: Type: integer
- query_configuration:
Type: QueryConfiguration
"The main query configuration. Defines for which primary entity the query
is to be executed, in which time frame and what query criteria are to be
used. Example:
{
"primary_entity": "SERVICE_FULFILLMENT",
"time_frame": {
"between": {
"start": "2015-01-01",
"end": "2016-06-30"
}
},
"query_tree_root": {
"leaves" : [ ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_STATUS_CODE",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "VIOLATED",
"value" : "VIOLATED"
} ]
}
}
} ],
"branches" : [ {
"leaves" : [ {
"query_criterion" : {
"generic" : {
"attribute_value" : "SLO_CLIENT",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "100",
"value" : 100
} ]
}
}
}, {
"query_criterion" : {
"generic" : {
"attribute_value" : "DAY_OF_MONTH",
"operator" : "EQUALS",
"expressions" : [ {
"label" : "1",
"value" : 1
} ]
}
}
} ],
"branches" : [ ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
} ],
"query_tree_root_operator" : "ALL"
}
}"
Sub Properties:
- chart_result:
Type: ChartResult
"Contains the contents of a chart (values, metadata). Optional elements
depend on the chart type (e.g. a table chart won't have
aggregation-dependent bins). Is usually a part of a chart endpoint
response. Example:
{
"bins": [
{
"label": "2015-10-01",
"value": 16709
},
{
"label": "2015-10-02",
"value": 16710
}
],
"chart_series": [
{
"values": [
{
"value": 194.96,
"element_description": {
"label": "",
"value": ""
}
},
{
"value": 72.61,
"element_description": {
"label": "",
"value": ""
}
}
],
"series_description": {
"label": "WINDOWS",
"value": "WINDOWS"
}
},
{
"values": [
{
"value": 0,
"element_description": {
"label": "",
"value": ""
}
},
{
"value": 0,
"element_description": {
"label": "",
"value": ""
}
}
],
"series_description": {
"label": "UNIX",
"value": "UNIX"
}
}
],
"type": "TIME_SERIES"
}"
Sub Properties:
- bins (optional):
Type: LabelledValue[]
"LabelledValue" array element:
"A description containing a label and a value. Example:
{
"label": "2015-W41",
"value": 2388
}"
Array Properties:
- label: Type: string
- value: Type: string
- chart_elements (optional):
Type: ChartElement[]
"ChartElement" array element:
"A single chart element, containing a value and description. Example:
{
"value": 233.67,
"element_description": {
"label": "",
"value": ""
}
}"
Array Properties:
- value: Type: number
- element_description:
Type: LabelledValue
"A description containing a label and a value. Example:
{
"label": "2015-W41",
"value": 2388
}"
Sub Properties:
- label: Type: string
- value: Type: string
- chart_series (optional):
Type: ChartSeries[]
"ChartSeries" array element:
"A chart element series containing an array of chart elements and a
description. Example:
{
"values": [
{
"value": 233.67,
"element_description": {
"label": "",
"value": ""
}
},
{
"value": 214.65,
"element_description": {
"label": "",
"value": ""
}
}
],
"series_description": {
"label": "SOME_AGENT",
"value": "SOME_AGENT"
}
}"
Array Properties:
- values:
Type: ChartElement[]
"ChartElement" array element:
"A single chart element, containing a value and description. Example:
{
"value": 233.67,
"element_description": {
"label": "",
"value": ""
}
}"
Array Properties:
- value: Type: number
- element_description:
Type: LabelledValue
"A description containing a label and a value. Example:
{
"label": "2015-W41",
"value": 2388
}"
Sub Properties:
- label: Type: string
- value: Type: string
- series_description:
Type: LabelledValue
"A description containing a label and a value. Example:
{
"label": "2015-W41",
"value": 2388
}"
Sub Properties:
- label: Type: string
- value: Type: string
- values:
Type: ChartElement[]
"ChartElement" array element:
"A single chart element, containing a value and description. Example:
{
"value": 233.67,
"element_description": {
"label": "",
"value": ""
}
}"
Array Properties:
- table_chart_header (optional):
Type: TableChartColumnHeader[]
"TableChartColumnHeader" array element:
"Values defining what type of data is stored in a table chart column. Used
mainly to format the values in the client. Example:
{
"id": "OBJECT_NAME",
"label": "Object Name",
"data_type": "java.lang.String",
"measurement": "NONE"
}"
Array Properties:
- id: Type: string
- label: Type: string
- data_type: Type: string
- measurement: Type: Measurement, Enumeration: [TIME,RATIO,NUMBER,NONE] "Type indicating what measurement a value describes. Can be used to format the value in the client depending on the measurement type. Example: { "id": "ERT", "label": "Estimated Runtime", "data_type": "java.lang.Integer", "measurement": "TIME" }"
- total_rows (optional): Type: integer
- total_rows_estimate (optional): Type: integer
- result (optional): Type: object[][]
- type: Type: ChartType, Enumeration: [PIE_DONUT,BAR_COLUMN,TABLE,TIME_SERIES,GROUPED_TABLE,DEVIATION] "Chart type."
- bins (optional):
Type: LabelledValue[]
"LabelledValue" array element:
"A description containing a label and a value. Example:
{
"label": "2015-W41",
"value": 2388
}"
Array Properties:
Example:
{
"chart_request": {
"query_configuration": {
"primary_entity": "JOB",
"time_frame": {
"last_full": {
"time_unit": "WEEK"
}
},
"query_tree_root": {
"leaves": [],
"branches": [
{
"leaves": [
{
"query_criterion": {
"generic": {
"attribute_value": "AGENT_TYPE",
"operator": "EQUALS",
"expressions": [
{
"label": "UNIX",
"value": "UNIX"
}
]
}
}
}
],
"branches": [
{
"leaves": [
{
"query_criterion": {
"generic": {
"attribute_value": "HOUR_OF_DAY",
"operator": "EQUALS",
"expressions": [
{
"label": "9",
"value": 9
}
]
}
}
},
{
"query_criterion": {
"generic": {
"attribute_value": "HOUR_OF_DAY",
"operator": "EQUALS",
"expressions": [
{
"label": "16",
"value": 16
}
]
}
}
}
],
"branches": [],
"query_tree_root_operator": "ANY"
}
],
"query_tree_root_operator": "ALL"
}
],
"query_tree_root_operator": "ALL"
}
},
"chart_configuration": {
"type": "PIE_DONUT",
"event": "END_TIME",
"aggregate": "COUNT",
"categorization": "STATUS_CODE_GROUP",
"grouping_limit": 15,
"grouping_order": "DESCENDING"
},
"time_zone": "UTC",
"timeout": 300
},
"chart_result": {
"chart_elements": [
{
"value" : 168,
"element_description": {
"label": "ANY_ABEND",
"value": "ANY_ABEND"
}
}
],
"type": "PIE_DONUT"
}
}
/shared_dashboards
The shared dashboard endpoint.
get
List all shared dashboards.
get /shared_dashboards
List all shared dashboards.
HTTP status code 200
Body
Media type: application/json
Type: SharedDashboardResponse
The following properties are returned:
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
- content:
Type: SharedDashboard[]
"SharedDashboard" array element:
"A single shared dashboard resource. It contains properties relevant to a
shared dashboard and a HAL links node. Example:
{
"share_id": "4ca43cf1-060d-4dd8-8cc2-6561ff687f9d",
"created_on": "2016-09-08T10:24:32.633Z",
"created_by": "USER",
"client": 1,
"name": "TEST.NEW",
"title": "",
"data": "
", "active": false, "all_clients": false, "timezone": "UTC", "content": [], "links": [ { "rel": "self", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" }, { "rel": "sharedDashboardEntity", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" } ] }" Array Properties: - share_id: Type: string
- created_on: Type: datetime
- created_by: Type: string
- client: Type: integer
- name: Type: string
- title: Type: string
- data: Type: string
- active: Type: boolean
- all_clients: Type: boolean
- timezone: Type: string
- content: Type: array
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
get
Get a shared dashboard by ID.
delete
Delete a shared dashboard.
get /shared_dashboards/{id}
Get a shared dashboard by ID.
URI Parameters
- id: required (string)
Query Parameters
- id: (string)
HTTP status code 200
Body
Media type: application/json
Type: SharedDashboard
The following properties are returned:
- share_id: Type: string
- created_on: Type: datetime
- created_by: Type: string
- client: Type: integer
- name: Type: string
- title: Type: string
- data: Type: string
- active: Type: boolean
- all_clients: Type: boolean
- timezone: Type: string
- content: Type: array
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
delete /shared_dashboards/{id}
get
Find all shared dashboards that belong to the specified AE client.
get /shared_dashboards/search/findByClient
Find all shared dashboards that belong to the specified AE client.
Query Parameters
- client: (integer)
HTTP status code 200
Body
Media type: application/json
Type: SharedDashboardResponse
The following properties are returned:
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
- content:
Type: SharedDashboard[]
"SharedDashboard" array element:
"A single shared dashboard resource. It contains properties relevant to a
shared dashboard and a HAL links node. Example:
{
"share_id": "4ca43cf1-060d-4dd8-8cc2-6561ff687f9d",
"created_on": "2016-09-08T10:24:32.633Z",
"created_by": "USER",
"client": 1,
"name": "TEST.NEW",
"title": "",
"data": "
", "active": false, "all_clients": false, "timezone": "UTC", "content": [], "links": [ { "rel": "self", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" }, { "rel": "sharedDashboardEntity", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" } ] }" Array Properties: - share_id: Type: string
- created_on: Type: datetime
- created_by: Type: string
- client: Type: integer
- name: Type: string
- title: Type: string
- data: Type: string
- active: Type: boolean
- all_clients: Type: boolean
- timezone: Type: string
- content: Type: array
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
get
Find all shared dashboards that have the provided name and AE client number.
get /shared_dashboards/search/findByClientAndName
Find all shared dashboards that have the provided name and AE client number.
Query Parameters
- client: (integer)
- name: (string)
HTTP status code 200
Body
Media type: application/json
Type: SharedDashboardResponse
The following properties are returned:
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
- content:
Type: SharedDashboard[]
"SharedDashboard" array element:
"A single shared dashboard resource. It contains properties relevant to a
shared dashboard and a HAL links node. Example:
{
"share_id": "4ca43cf1-060d-4dd8-8cc2-6561ff687f9d",
"created_on": "2016-09-08T10:24:32.633Z",
"created_by": "USER",
"client": 1,
"name": "TEST.NEW",
"title": "",
"data": "
", "active": false, "all_clients": false, "timezone": "UTC", "content": [], "links": [ { "rel": "self", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" }, { "rel": "sharedDashboardEntity", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" } ] }" Array Properties: - share_id: Type: string
- created_on: Type: datetime
- created_by: Type: string
- client: Type: integer
- name: Type: string
- title: Type: string
- data: Type: string
- active: Type: boolean
- all_clients: Type: boolean
- timezone: Type: string
- content: Type: array
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
get
Find all shared dashboards that have the provided name, AE client number and the creator's user name.
get /shared_dashboards/search/findByClientAndNameAndCreatedBy
Find all shared dashboards that have the provided name, AE client number and the creator's user name.
Query Parameters
- client: (integer)
- name: (string)
- createdBy: (string)
HTTP status code 200
Body
Media type: application/json
Type: SharedDashboardResponse
The following properties are returned:
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
- content:
Type: SharedDashboard[]
"SharedDashboard" array element:
"A single shared dashboard resource. It contains properties relevant to a
shared dashboard and a HAL links node. Example:
{
"share_id": "4ca43cf1-060d-4dd8-8cc2-6561ff687f9d",
"created_on": "2016-09-08T10:24:32.633Z",
"created_by": "USER",
"client": 1,
"name": "TEST.NEW",
"title": "",
"data": "
", "active": false, "all_clients": false, "timezone": "UTC", "content": [], "links": [ { "rel": "self", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" }, { "rel": "sharedDashboardEntity", "href": "http://localhost:8443/analytics/api/v1/shared_dashboards/4ca43cf1-060d-4dd8-8cc2-6561ff687f9d" } ] }" Array Properties: - share_id: Type: string
- created_on: Type: datetime
- created_by: Type: string
- client: Type: integer
- name: Type: string
- title: Type: string
- data: Type: string
- active: Type: boolean
- all_clients: Type: boolean
- timezone: Type: string
- content: Type: array
- links:
Type: HALLink[]
"HALLink" array element:
"A HAL links node. Its structure conforms to the Hypertext Application
Language specification. Example:
{
"rel": "self",
"href": "http://localhost:8443/analytics/api/v1/shared_dashboards"
}"
Array Properties:
- rel: Type: string
- href: Type: string
/telemetry
The Telemetry endpoint.
get
Get filtered and anonymized data for consumer specified by consumer ID {id}.
get /telemetry/consumers/{id}
Get filtered and anonymized data for consumer specified by consumer ID {id}.
URI Parameters
- id: required (string)
Consumer's ID.
Query Parameters
- sizelimitmb: (number)
Threshold of exported data size in Mb after which the export should stop to limit the size of the exported data file.
Example:
100 - manualacknowledge: (boolean)
Specifies whether acknowledgment should be done manually or automatically (default is false).
Example:
true
HTTP status code 200
Successful Response. File in Avro Object Container format. The header of the file will contain the following metadata:
- telemetry.ae_system_name
- telemetry.customer_id
- telemetry.analytics_backend_id
- telemetry.export_context
The last block in the file will contain a single status record of type DataExportStatus. The status and message of this record should be checked to determine whether the export was successful (status should be > 0).
The header of the file will also contain the Avro schema for the data in the file (some of the types in the union may not be available depending on how category export filtering is configured on the server):
[{
"type": "record",
"name": "AEAgentsPerCPV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsPerCPV1",
"doc": "AE Agents per CP",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "cp_name",
"type": "string",
"doc": "CP name"
}, {
"name": "connection_count",
"type": "int",
"doc": "Number of Agent connected to CP"
}
]
}, {
"type": "record",
"name": "AEAgentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsV1",
"doc": "AE Agents",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Agent Snapshot timestamp"
}, {
"name": "agent_name",
"type": "string",
"doc": "AE Agent name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "active",
"type": "int",
"doc": "PEER active = 1"
}, {
"name": "attr_type",
"type": "string",
"doc": "Attribute type corresponding to table UC_HTYP"
}, {
"name": "version",
"type": "string",
"doc": "Executor version"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "software",
"type": "string",
"doc": "Software"
}, {
"name": "software_vers",
"type": "string",
"doc": "Software version"
}, {
"name": "license_class",
"type": "string",
"doc": "License class"
}, {
"name": "lic_category",
"type": "string",
"doc": "License calegory"
}, {
"name": "net_area",
"type": "string",
"doc": "The NetArea in which this Agent runs"
}
]
}, {
"type": "record",
"name": "AEDbInfoV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEDbInfoV1",
"doc": "AE Db Info",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "vendor",
"type": "string"
}, {
"name": "version",
"type": "string"
}
]
}, {
"type": "record",
"name": "AEObjectsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEObjectsV1",
"doc": "AE Objects",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Object Snapshot timestamp"
}, {
"name": "client_id",
"type": "int",
"doc": "Client Id"
}, {
"name": "object_type",
"type": "string",
"doc": "Object Type"
}, {
"name": "object_count",
"type": "int",
"doc": "Object Count"
}
]
}, {
"type": "record",
"name": "AEPerfGlobalV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfGlobalV1",
"doc": "AE Performance management global metrics",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Overall Metric timestamp"
}, {
"name": "overall_metrics",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "OverallMetric",
"doc": "Overall metric",
"fields": [{
"name": "metric",
"type": "string",
"doc": "Overall Metric name"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}
},
"doc": "Array of all overall metrics"
}
]
}, {
"type": "record",
"name": "AEPerfIssuesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfIssuesV1",
"doc": "AE Performance management Issues",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Issue timestamp"
}, {
"name": "issue_idnr",
"type": "int",
"doc": "Issue idnr"
}, {
"name": "msg_insert",
"type": "string",
"doc": "Issue insert message"
}, {
"name": "quit_comment",
"type": "string",
"doc": "Quit comment"
}
]
}, {
"type": "record",
"name": "AEPerfProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfProcessesV1",
"doc": "AE Performance Process management metric",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name. MsgDist: metric about message occurrences. TimevsDB: metric about used time and DB times. MsgTime: mean time of occurred message. MQLength: metric about the length of the message queue tables. MQCount: count of the message queues."
}, {
"name": "wp_name",
"type": "string",
"doc": "Process name"
}, {
"name": "tcpip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "srv_type",
"type": "int",
"doc": "Server type"
}, {
"name": "interval",
"type": "int",
"doc": "Interval"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}, {
"type": "record",
"name": "AEProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEProcessesV1",
"doc": "AE Processes",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Process Snapshot timestamp"
}, {
"name": "server_name",
"type": "string",
"doc": "Server name"
}, {
"name": "system",
"type": "string",
"doc": "AE system name"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "type",
"type": "int",
"doc": "Process type (1=CP, 2=WP, 4=PWP, 8=Agent)"
}, {
"name": "start_time",
"type": "string",
"doc": "Process start date"
}, {
"name": "last_update",
"type": "string",
"doc": "Process update date"
}, {
"name": "ip_add2",
"type": "string",
"doc": "local IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "net_area",
"type": "string",
"doc": "Network area"
}, {
"name": "mq_set",
"type": "string",
"doc": "MQ set (1 for new MQ1* and 2 for new MQ2*)"
}, {
"name": "version",
"type": "string",
"doc": "AE version"
}
]
}, {
"type": "record",
"name": "AESysVarV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AESysVarV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "name",
"type": "string"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A container for key value pairs",
"fields": [{
"name": "key",
"type": "string",
"doc": "key"
}, {
"name": "value",
"type": "string",
"doc": "value"
}
]
}
},
"doc": "Array of key value pairs"
}
]
}, {
"type": "record",
"name": "AEWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEWorkflowsV1",
"doc": "AE Workflows data",
"fields": [{
"name": "run_id",
"type": "long",
"doc": "run identifier"
}, {
"name": "workflow_name",
"type": "string",
"doc": "Workflow name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "activation_time",
"type": "string",
"doc": "Activation timestamp"
}, {
"name": "start_time",
"type": "string",
"doc": "Start timestamp"
}, {
"name": "end_time",
"type": "string",
"doc": "end time (including post processing time if available)"
}, {
"name": "status",
"type": "long",
"doc": "state of the activity"
}, {
"name": "ert",
"type": "long",
"doc": "estimated runtime"
}
]
}, {
"type": "record",
"name": "ARComponentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARComponentsV1",
"doc": "ARA Component collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "Id"
}, {
"name": "application_name",
"type": "string",
"doc": "Application name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "application_type",
"type": "string",
"doc": "Application type"
}, {
"name": "application_is_archived",
"type": "boolean",
"doc": "Application is archived"
}, {
"name": "application_creation_time",
"type": "string",
"doc": "Application creation time"
}, {
"name": "application_last_changed",
"type": "string",
"doc": "Application last changed"
}, {
"name": "component_name",
"type": "string",
"doc": "Component name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "component_type",
"type": "string",
"doc": "Component type"
}, {
"name": "app_id",
"type": "long",
"doc": "Application ID"
}, {
"name": "component_is_archived",
"type": "boolean",
"doc": "Component is archived"
}, {
"name": "component_creation_time",
"type": "string",
"doc": "Component creation time"
}, {
"name": "component_last_changed",
"type": "string",
"doc": "Component last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetPerAgentV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetPerAgentV1",
"doc": "ARA Deployment target Per Agent collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "name",
"type": "string",
"doc": "Name"
}, {
"name": "is_active",
"type": "boolean",
"doc": "Is active"
}, {
"name": "agent",
"type": "string",
"doc": "Agent name"
}, {
"name": "agent_type",
"type": "string",
"doc": "Agent type"
}, {
"name": "target_type",
"type": "string",
"doc": "Deployment Target type"
}, {
"name": "handler_id",
"type": "long",
"doc": "Deployment Target Handler ID"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Creation time"
}, {
"name": "last_changed",
"type": "string",
"doc": "Last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetsV1",
"doc": "ARA Deployment Target collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "environment_name",
"type": "string",
"doc": "Environment name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_type",
"type": "string",
"doc": "Environment type"
}, {
"name": "environment_is_archived",
"type": "boolean",
"doc": "Environment is archived"
}, {
"name": "environment_creation_time",
"type": "string",
"doc": "Environment creation time"
}, {
"name": "environment_last_changed",
"type": "string",
"doc": "Environment last changed"
}, {
"name": "target_name",
"type": "string",
"doc": "Target name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "target_type",
"type": "string",
"doc": "Target type"
}, {
"name": "target_active",
"type": "boolean",
"doc": "Target active"
}, {
"name": "target_is_archived",
"type": "boolean",
"doc": "Target is archived"
}, {
"name": "target_creation_time",
"type": "string",
"doc": "Target creation time"
}, {
"name": "target_last_changed",
"type": "string",
"doc": "Target last changed"
}, {
"name": "target_env_id",
"type": "long",
"doc": "Target Environment ID"
}
]
}, {
"type": "record",
"name": "ARPackagesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARPackagesV1",
"doc": "ARA Packages collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_name",
"type": "string",
"doc": "Package Name"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_state",
"type": "string",
"doc": "State of the package"
}, {
"name": "type_id",
"type": "long",
"doc": "Package Custom Type ID"
}, {
"name": "package_type",
"type": "string",
"doc": "Package Custom Type Name"
}, {
"name": "base_type",
"type": "int",
"doc": "Base Type of the package. 0=Generic, 1=Deployment"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the package is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the package has been created"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the package was changed the last time, i.e. state changed"
}, {
"name": "application_name",
"type": "string",
"doc": "name of the application which the package is belonging to",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}, {
"type": "record",
"name": "ARWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARWorkflowsV1",
"doc": "ARA Workflow collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Execution ID"
}, {
"name": "actual_from",
"type": "string",
"doc": "Deployment start time"
}, {
"name": "actual_to",
"type": "string",
"doc": "Deployment end time"
}, {
"name": "runtime_in_seconds",
"type": "int",
"doc": "Run time in seconds"
}, {
"name": "run_id",
"type": "int",
"doc": "Run ID in the Automation Engine"
}, {
"name": "status",
"type": "int",
"doc": "Current state of workflow executions. 0=WaitingApproval, 1=WaitingStartTime, 2=WaitingManualConfirm, 3=Active, 4=Blocked, 5=Rejected, 6=Revoked, 7=Canceled, 8=Finished, 9=Failed"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the workflow execution is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the execution has been created (either started or planned)"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the execution was changed the last time, i.e. state changed"
}, {
"name": "result",
"type": "int",
"doc": "Result of deployment history: 0=NA, 1=Failed, 2=Finished, 3=Canceled"
}, {
"name": "application_id",
"type": "long",
"doc": "Id of the Application that is being deployed by the Package"
}, {
"name": "application_name",
"type": "string",
"doc": "Application that is being deployed by the Package",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_id",
"type": "long",
"doc": "Id of the Environment that the Package is deployed to"
}, {
"name": "environment_name",
"type": "string",
"doc": "Name of the Environment that the Package is deployed to",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "patch_id",
"type": "string",
"doc": "ID of the package being patched by the package"
}, {
"name": "deployment_profile_id",
"type": "long",
"doc": "Id of the Deployment Profile"
}, {
"name": "deployment_profile_name",
"type": "string",
"doc": "Name of the Deployment Profile",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "deployment_descriptor_size",
"type": "int",
"doc": "Size of the deployment descriptor in byte"
}, {
"name": "queue_run_id",
"type": "long",
"doc": "Queue Run ID"
}, {
"name": "start_mode",
"type": "int",
"doc": "Execution start mode.0=Immediately, 1=ImmediatelyWithConfirmation, 2=AtPlannedTime, 3=AtPlannedTimeWithConfirmation = 3, 4=InQueue, 5=InQueueWithConfirmation"
}, {
"name": "workflow_mode",
"type": "int",
"doc": "Workflow mode. 0=Install, 1=Uninstall, 2=Other, 3=Provisioning"
}, {
"name": "installation_mode",
"type": "int",
"doc": "Installation mode. 0=Skip, 1=Override"
}
]
}, {
"type": "record",
"name": "MetricV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV2",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV3",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "OSMetricsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.OSMetricsV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agt_type",
"type": "string"
}, {
"name": "agt_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "mo_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "os_info",
"type": "string"
}, {
"name": "calc_period_sec",
"type": "int"
}, {
"name": "metrics_array",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "sldmetric",
"fields": [{
"name": "code",
"type": "string"
}, {
"name": "instance",
"type": "string"
}, {
"name": "avg_value",
"type": "double"
}, {
"name": "max_value",
"type": "double"
}, {
"name": "min_value",
"type": "double"
}, {
"name": "pct_info",
"type": "double"
}
]
}
}
}
]
}, {
"type": "record",
"name": "SnapshotV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV1",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV2",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV3",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}, {
"name": "snapshot_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "XXApeCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXApeCustomV1",
"doc": "Custom Metric (Automation Platform Environment)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXUiuCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXUiuCustomV1",
"doc": "Custom Metric (User Interface Usage)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWdfCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWdfCustomV1",
"doc": "Custom Metric (Workflow Definitions)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWecCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWecCustomV1",
"doc": "Custom Metric (Workflow Environment Context)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWexCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWexCustomV1",
"doc": "Custom Metric (Workflow Execution Statistics)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "DataExportStatus",
"namespace": "com.automic.analytics.telemetry.dataexport.dataexportstatus",
"fields": [{
"name": "status",
"type": "int",
"default": 0
}, {
"name": "message",
"type": "string",
"default": ""
}, {
"name": "stats",
"type": {
"type": "record",
"name": "Stats",
"fields": [{
"name": "exported_records",
"type": "long",
"default": -1
}, {
"name": "failed_records",
"type": "long",
"default": -1
}
]
},
"default": {}
}, {
"name": "manual_ack_data",
"type": {
"type": "record",
"name": "ManualAckData",
"fields": [{
"name": "last_offsets",
"type": {
"type": "map",
"values": {
"type": "map",
"values": "long"
}
},
"default": {}
}
]
},
"default": {}
}
]
}
]
Body
Media type: application/octet-stream
Type: application/octet-stream
post
Consume filtered and anonymized data from starting points and up to end points specified in POST data with consumer ID specified in {id}.
post /telemetry/consumers/{id}/replay
Consume filtered and anonymized data from starting points and up to end points specified in POST data with consumer ID specified in {id}.
URI Parameters
- id: required (string)
Consumer's ID.
Query Parameters
- sizelimitmb: (number)
Threshold of exported data size in Mb after which the export should stop to limit the size of the exported data file.
Example:
100 - manualacknowledge: (boolean)
Specifies whether acknowledgment should be done manually or automatically (default is false).
Example:
true
Body
Media type: application/json
Type:
{
"$ref" : "#/definitions/telemetry-dataexport-ReplayInfo",
"definitions" : {
"telemetry-dataexport-ReplayInfo" : {
"type" : "object",
"required" : [ "start_offsets", "last_offsets" ],
"additionalProperties" : false,
"properties" : {
"start_offsets" : {
"default" : { },
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : -9223372036854775808,
"maximum" : 9223372036854775807
}
}
},
"last_offsets" : {
"default" : { },
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : -9223372036854775808,
"maximum" : 9223372036854775807
}
}
}
}
}
}
}Examples:
With-end-boundaries:
{
"start_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 10
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 34
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 231
}
},
"last_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 355
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 40
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 901
}
}
}
Without-end-boundaries:
{
"start_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 10
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 34
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 231
}
},
"last_offsets": {
}
}
HTTP status code 200
Successful Response. File in Avro Object Container format. The header of the file will contain the following metadata:
- telemetry.ae_system_name
- telemetry.customer_id
- telemetry.analytics_backend_id
- telemetry.export_context
The last block in the file will contain a single status record of type DataExportStatus. The status and message of this record should be checked to determine whether the export was successful (status should be > 0).
The header of the file will also contain the Avro schema for the data in the file (some of the types in the union may not be available depending on how category export filtering is configured on the server):
[{
"type": "record",
"name": "AEAgentsPerCPV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsPerCPV1",
"doc": "AE Agents per CP",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "cp_name",
"type": "string",
"doc": "CP name"
}, {
"name": "connection_count",
"type": "int",
"doc": "Number of Agent connected to CP"
}
]
}, {
"type": "record",
"name": "AEAgentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsV1",
"doc": "AE Agents",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Agent Snapshot timestamp"
}, {
"name": "agent_name",
"type": "string",
"doc": "AE Agent name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "active",
"type": "int",
"doc": "PEER active = 1"
}, {
"name": "attr_type",
"type": "string",
"doc": "Attribute type corresponding to table UC_HTYP"
}, {
"name": "version",
"type": "string",
"doc": "Executor version"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "software",
"type": "string",
"doc": "Software"
}, {
"name": "software_vers",
"type": "string",
"doc": "Software version"
}, {
"name": "license_class",
"type": "string",
"doc": "License class"
}, {
"name": "lic_category",
"type": "string",
"doc": "License calegory"
}, {
"name": "net_area",
"type": "string",
"doc": "The NetArea in which this Agent runs"
}
]
}, {
"type": "record",
"name": "AEDbInfoV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEDbInfoV1",
"doc": "AE Db Info",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "vendor",
"type": "string"
}, {
"name": "version",
"type": "string"
}
]
}, {
"type": "record",
"name": "AEObjectsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEObjectsV1",
"doc": "AE Objects",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Object Snapshot timestamp"
}, {
"name": "client_id",
"type": "int",
"doc": "Client Id"
}, {
"name": "object_type",
"type": "string",
"doc": "Object Type"
}, {
"name": "object_count",
"type": "int",
"doc": "Object Count"
}
]
}, {
"type": "record",
"name": "AEPerfGlobalV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfGlobalV1",
"doc": "AE Performance management global metrics",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Overall Metric timestamp"
}, {
"name": "overall_metrics",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "OverallMetric",
"doc": "Overall metric",
"fields": [{
"name": "metric",
"type": "string",
"doc": "Overall Metric name"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}
},
"doc": "Array of all overall metrics"
}
]
}, {
"type": "record",
"name": "AEPerfIssuesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfIssuesV1",
"doc": "AE Performance management Issues",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Issue timestamp"
}, {
"name": "issue_idnr",
"type": "int",
"doc": "Issue idnr"
}, {
"name": "msg_insert",
"type": "string",
"doc": "Issue insert message"
}, {
"name": "quit_comment",
"type": "string",
"doc": "Quit comment"
}
]
}, {
"type": "record",
"name": "AEPerfProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfProcessesV1",
"doc": "AE Performance Process management metric",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name. MsgDist: metric about message occurrences. TimevsDB: metric about used time and DB times. MsgTime: mean time of occurred message. MQLength: metric about the length of the message queue tables. MQCount: count of the message queues."
}, {
"name": "wp_name",
"type": "string",
"doc": "Process name"
}, {
"name": "tcpip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "srv_type",
"type": "int",
"doc": "Server type"
}, {
"name": "interval",
"type": "int",
"doc": "Interval"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}, {
"type": "record",
"name": "AEProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEProcessesV1",
"doc": "AE Processes",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Process Snapshot timestamp"
}, {
"name": "server_name",
"type": "string",
"doc": "Server name"
}, {
"name": "system",
"type": "string",
"doc": "AE system name"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "type",
"type": "int",
"doc": "Process type (1=CP, 2=WP, 4=PWP, 8=Agent)"
}, {
"name": "start_time",
"type": "string",
"doc": "Process start date"
}, {
"name": "last_update",
"type": "string",
"doc": "Process update date"
}, {
"name": "ip_add2",
"type": "string",
"doc": "local IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "net_area",
"type": "string",
"doc": "Network area"
}, {
"name": "mq_set",
"type": "string",
"doc": "MQ set (1 for new MQ1* and 2 for new MQ2*)"
}, {
"name": "version",
"type": "string",
"doc": "AE version"
}
]
}, {
"type": "record",
"name": "AESysVarV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AESysVarV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "name",
"type": "string"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A container for key value pairs",
"fields": [{
"name": "key",
"type": "string",
"doc": "key"
}, {
"name": "value",
"type": "string",
"doc": "value"
}
]
}
},
"doc": "Array of key value pairs"
}
]
}, {
"type": "record",
"name": "AEWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEWorkflowsV1",
"doc": "AE Workflows data",
"fields": [{
"name": "run_id",
"type": "long",
"doc": "run identifier"
}, {
"name": "workflow_name",
"type": "string",
"doc": "Workflow name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "activation_time",
"type": "string",
"doc": "Activation timestamp"
}, {
"name": "start_time",
"type": "string",
"doc": "Start timestamp"
}, {
"name": "end_time",
"type": "string",
"doc": "end time (including post processing time if available)"
}, {
"name": "status",
"type": "long",
"doc": "state of the activity"
}, {
"name": "ert",
"type": "long",
"doc": "estimated runtime"
}
]
}, {
"type": "record",
"name": "ARComponentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARComponentsV1",
"doc": "ARA Component collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "Id"
}, {
"name": "application_name",
"type": "string",
"doc": "Application name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "application_type",
"type": "string",
"doc": "Application type"
}, {
"name": "application_is_archived",
"type": "boolean",
"doc": "Application is archived"
}, {
"name": "application_creation_time",
"type": "string",
"doc": "Application creation time"
}, {
"name": "application_last_changed",
"type": "string",
"doc": "Application last changed"
}, {
"name": "component_name",
"type": "string",
"doc": "Component name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "component_type",
"type": "string",
"doc": "Component type"
}, {
"name": "app_id",
"type": "long",
"doc": "Application ID"
}, {
"name": "component_is_archived",
"type": "boolean",
"doc": "Component is archived"
}, {
"name": "component_creation_time",
"type": "string",
"doc": "Component creation time"
}, {
"name": "component_last_changed",
"type": "string",
"doc": "Component last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetPerAgentV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetPerAgentV1",
"doc": "ARA Deployment target Per Agent collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "name",
"type": "string",
"doc": "Name"
}, {
"name": "is_active",
"type": "boolean",
"doc": "Is active"
}, {
"name": "agent",
"type": "string",
"doc": "Agent name"
}, {
"name": "agent_type",
"type": "string",
"doc": "Agent type"
}, {
"name": "target_type",
"type": "string",
"doc": "Deployment Target type"
}, {
"name": "handler_id",
"type": "long",
"doc": "Deployment Target Handler ID"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Creation time"
}, {
"name": "last_changed",
"type": "string",
"doc": "Last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetsV1",
"doc": "ARA Deployment Target collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "environment_name",
"type": "string",
"doc": "Environment name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_type",
"type": "string",
"doc": "Environment type"
}, {
"name": "environment_is_archived",
"type": "boolean",
"doc": "Environment is archived"
}, {
"name": "environment_creation_time",
"type": "string",
"doc": "Environment creation time"
}, {
"name": "environment_last_changed",
"type": "string",
"doc": "Environment last changed"
}, {
"name": "target_name",
"type": "string",
"doc": "Target name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "target_type",
"type": "string",
"doc": "Target type"
}, {
"name": "target_active",
"type": "boolean",
"doc": "Target active"
}, {
"name": "target_is_archived",
"type": "boolean",
"doc": "Target is archived"
}, {
"name": "target_creation_time",
"type": "string",
"doc": "Target creation time"
}, {
"name": "target_last_changed",
"type": "string",
"doc": "Target last changed"
}, {
"name": "target_env_id",
"type": "long",
"doc": "Target Environment ID"
}
]
}, {
"type": "record",
"name": "ARPackagesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARPackagesV1",
"doc": "ARA Packages collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_name",
"type": "string",
"doc": "Package Name"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_state",
"type": "string",
"doc": "State of the package"
}, {
"name": "type_id",
"type": "long",
"doc": "Package Custom Type ID"
}, {
"name": "package_type",
"type": "string",
"doc": "Package Custom Type Name"
}, {
"name": "base_type",
"type": "int",
"doc": "Base Type of the package. 0=Generic, 1=Deployment"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the package is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the package has been created"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the package was changed the last time, i.e. state changed"
}, {
"name": "application_name",
"type": "string",
"doc": "name of the application which the package is belonging to",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}, {
"type": "record",
"name": "ARWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARWorkflowsV1",
"doc": "ARA Workflow collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Execution ID"
}, {
"name": "actual_from",
"type": "string",
"doc": "Deployment start time"
}, {
"name": "actual_to",
"type": "string",
"doc": "Deployment end time"
}, {
"name": "runtime_in_seconds",
"type": "int",
"doc": "Run time in seconds"
}, {
"name": "run_id",
"type": "int",
"doc": "Run ID in the Automation Engine"
}, {
"name": "status",
"type": "int",
"doc": "Current state of workflow executions. 0=WaitingApproval, 1=WaitingStartTime, 2=WaitingManualConfirm, 3=Active, 4=Blocked, 5=Rejected, 6=Revoked, 7=Canceled, 8=Finished, 9=Failed"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the workflow execution is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the execution has been created (either started or planned)"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the execution was changed the last time, i.e. state changed"
}, {
"name": "result",
"type": "int",
"doc": "Result of deployment history: 0=NA, 1=Failed, 2=Finished, 3=Canceled"
}, {
"name": "application_id",
"type": "long",
"doc": "Id of the Application that is being deployed by the Package"
}, {
"name": "application_name",
"type": "string",
"doc": "Application that is being deployed by the Package",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_id",
"type": "long",
"doc": "Id of the Environment that the Package is deployed to"
}, {
"name": "environment_name",
"type": "string",
"doc": "Name of the Environment that the Package is deployed to",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "patch_id",
"type": "string",
"doc": "ID of the package being patched by the package"
}, {
"name": "deployment_profile_id",
"type": "long",
"doc": "Id of the Deployment Profile"
}, {
"name": "deployment_profile_name",
"type": "string",
"doc": "Name of the Deployment Profile",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "deployment_descriptor_size",
"type": "int",
"doc": "Size of the deployment descriptor in byte"
}, {
"name": "queue_run_id",
"type": "long",
"doc": "Queue Run ID"
}, {
"name": "start_mode",
"type": "int",
"doc": "Execution start mode.0=Immediately, 1=ImmediatelyWithConfirmation, 2=AtPlannedTime, 3=AtPlannedTimeWithConfirmation = 3, 4=InQueue, 5=InQueueWithConfirmation"
}, {
"name": "workflow_mode",
"type": "int",
"doc": "Workflow mode. 0=Install, 1=Uninstall, 2=Other, 3=Provisioning"
}, {
"name": "installation_mode",
"type": "int",
"doc": "Installation mode. 0=Skip, 1=Override"
}
]
}, {
"type": "record",
"name": "MetricV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV2",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV3",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "OSMetricsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.OSMetricsV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agt_type",
"type": "string"
}, {
"name": "agt_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "mo_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "os_info",
"type": "string"
}, {
"name": "calc_period_sec",
"type": "int"
}, {
"name": "metrics_array",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "sldmetric",
"fields": [{
"name": "code",
"type": "string"
}, {
"name": "instance",
"type": "string"
}, {
"name": "avg_value",
"type": "double"
}, {
"name": "max_value",
"type": "double"
}, {
"name": "min_value",
"type": "double"
}, {
"name": "pct_info",
"type": "double"
}
]
}
}
}
]
}, {
"type": "record",
"name": "SnapshotV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV1",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV2",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV3",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}, {
"name": "snapshot_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "XXApeCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXApeCustomV1",
"doc": "Custom Metric (Automation Platform Environment)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXUiuCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXUiuCustomV1",
"doc": "Custom Metric (User Interface Usage)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWdfCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWdfCustomV1",
"doc": "Custom Metric (Workflow Definitions)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWecCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWecCustomV1",
"doc": "Custom Metric (Workflow Environment Context)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWexCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWexCustomV1",
"doc": "Custom Metric (Workflow Execution Statistics)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "DataExportStatus",
"namespace": "com.automic.analytics.telemetry.dataexport.dataexportstatus",
"fields": [{
"name": "status",
"type": "int",
"default": 0
}, {
"name": "message",
"type": "string",
"default": ""
}, {
"name": "stats",
"type": {
"type": "record",
"name": "Stats",
"fields": [{
"name": "exported_records",
"type": "long",
"default": -1
}, {
"name": "failed_records",
"type": "long",
"default": -1
}
]
},
"default": {}
}, {
"name": "manual_ack_data",
"type": {
"type": "record",
"name": "ManualAckData",
"fields": [{
"name": "last_offsets",
"type": {
"type": "map",
"values": {
"type": "map",
"values": "long"
}
},
"default": {}
}
]
},
"default": {}
}
]
}
]
Body
Media type: application/octet-stream
Type: application/octet-stream
post
Perform acknowledgement for consumed data specified in POST body and with consumer ID specified in {id}.
post /telemetry/consumers/{id}/acknowledge
Perform acknowledgement for consumed data specified in POST body and with consumer ID specified in {id}.
URI Parameters
- id: required (string)
Consumer's ID.
Body
Media type: application/json
Type:
{
"$ref" : "#/definitions/telemetry-dataexport-AcknowledgeData",
"definitions" : {
"telemetry-dataexport-AcknowledgeData" : {
"type" : "object",
"required" : [ "last_offsets" ],
"additionalProperties" : false,
"properties" : {
"last_offsets" : {
"default" : { },
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : -9223372036854775808,
"maximum" : 9223372036854775807
}
}
}
}
}
}
}Example:
{
"last_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 355
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 40
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 901
}
}
}
HTTP status code 200
An empty body is returned.
Body
Media type: application/json
Type: application/json
get
Get all data for consumer specified by consumer ID {id}.
get /telemetry/private-consumers/{id}
Get all data for consumer specified by consumer ID {id}.
URI Parameters
- id: required (string)
Consumer's ID.
Query Parameters
- sizelimitmb: (number)
Threshold of exported data size in Mb after which the export should stop to limit the size of the exported data file.
Example:
100 - manualacknowledge: (boolean)
Specifies whether acknowledgment should be done manually or automatically (default is false).
Example:
true
HTTP status code 200
Successful Response. File in Avro Object Container format. The header of the file will contain the following metadata:
- telemetry.ae_system_name
- telemetry.customer_id
- telemetry.analytics_backend_id
- telemetry.export_context
The last block in the file will contain a single status record of type DataExportStatus. The status and message of this record should be checked to determine whether the export was successful (status should be > 0).
The header of the file will also contain the Avro schema for the data in the file:
[{
"type": "record",
"name": "AEAgentsPerCPV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsPerCPV1",
"doc": "AE Agents per CP",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "cp_name",
"type": "string",
"doc": "CP name"
}, {
"name": "connection_count",
"type": "int",
"doc": "Number of Agent connected to CP"
}
]
}, {
"type": "record",
"name": "AEAgentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsV1",
"doc": "AE Agents",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Agent Snapshot timestamp"
}, {
"name": "agent_name",
"type": "string",
"doc": "AE Agent name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "active",
"type": "int",
"doc": "PEER active = 1"
}, {
"name": "attr_type",
"type": "string",
"doc": "Attribute type corresponding to table UC_HTYP"
}, {
"name": "version",
"type": "string",
"doc": "Executor version"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "software",
"type": "string",
"doc": "Software"
}, {
"name": "software_vers",
"type": "string",
"doc": "Software version"
}, {
"name": "license_class",
"type": "string",
"doc": "License class"
}, {
"name": "lic_category",
"type": "string",
"doc": "License calegory"
}, {
"name": "net_area",
"type": "string",
"doc": "The NetArea in which this Agent runs"
}
]
}, {
"type": "record",
"name": "AEDbInfoV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEDbInfoV1",
"doc": "AE Db Info",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "vendor",
"type": "string"
}, {
"name": "version",
"type": "string"
}
]
}, {
"type": "record",
"name": "AEObjectsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEObjectsV1",
"doc": "AE Objects",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Object Snapshot timestamp"
}, {
"name": "client_id",
"type": "int",
"doc": "Client Id"
}, {
"name": "object_type",
"type": "string",
"doc": "Object Type"
}, {
"name": "object_count",
"type": "int",
"doc": "Object Count"
}
]
}, {
"type": "record",
"name": "AEPerfGlobalV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfGlobalV1",
"doc": "AE Performance management global metrics",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Overall Metric timestamp"
}, {
"name": "overall_metrics",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "OverallMetric",
"doc": "Overall metric",
"fields": [{
"name": "metric",
"type": "string",
"doc": "Overall Metric name"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}
},
"doc": "Array of all overall metrics"
}
]
}, {
"type": "record",
"name": "AEPerfIssuesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfIssuesV1",
"doc": "AE Performance management Issues",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Issue timestamp"
}, {
"name": "issue_idnr",
"type": "int",
"doc": "Issue idnr"
}, {
"name": "msg_insert",
"type": "string",
"doc": "Issue insert message"
}, {
"name": "quit_comment",
"type": "string",
"doc": "Quit comment"
}
]
}, {
"type": "record",
"name": "AEPerfProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfProcessesV1",
"doc": "AE Performance Process management metric",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name. MsgDist: metric about message occurrences. TimevsDB: metric about used time and DB times. MsgTime: mean time of occurred message. MQLength: metric about the length of the message queue tables. MQCount: count of the message queues."
}, {
"name": "wp_name",
"type": "string",
"doc": "Process name"
}, {
"name": "tcpip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "srv_type",
"type": "int",
"doc": "Server type"
}, {
"name": "interval",
"type": "int",
"doc": "Interval"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}, {
"type": "record",
"name": "AEProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEProcessesV1",
"doc": "AE Processes",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Process Snapshot timestamp"
}, {
"name": "server_name",
"type": "string",
"doc": "Server name"
}, {
"name": "system",
"type": "string",
"doc": "AE system name"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "type",
"type": "int",
"doc": "Process type (1=CP, 2=WP, 4=PWP, 8=Agent)"
}, {
"name": "start_time",
"type": "string",
"doc": "Process start date"
}, {
"name": "last_update",
"type": "string",
"doc": "Process update date"
}, {
"name": "ip_add2",
"type": "string",
"doc": "local IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "net_area",
"type": "string",
"doc": "Network area"
}, {
"name": "mq_set",
"type": "string",
"doc": "MQ set (1 for new MQ1* and 2 for new MQ2*)"
}, {
"name": "version",
"type": "string",
"doc": "AE version"
}
]
}, {
"type": "record",
"name": "AESysVarV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AESysVarV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "name",
"type": "string"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A container for key value pairs",
"fields": [{
"name": "key",
"type": "string",
"doc": "key"
}, {
"name": "value",
"type": "string",
"doc": "value"
}
]
}
},
"doc": "Array of key value pairs"
}
]
}, {
"type": "record",
"name": "AEWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEWorkflowsV1",
"doc": "AE Workflows data",
"fields": [{
"name": "run_id",
"type": "long",
"doc": "run identifier"
}, {
"name": "workflow_name",
"type": "string",
"doc": "Workflow name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "activation_time",
"type": "string",
"doc": "Activation timestamp"
}, {
"name": "start_time",
"type": "string",
"doc": "Start timestamp"
}, {
"name": "end_time",
"type": "string",
"doc": "end time (including post processing time if available)"
}, {
"name": "status",
"type": "long",
"doc": "state of the activity"
}, {
"name": "ert",
"type": "long",
"doc": "estimated runtime"
}
]
}, {
"type": "record",
"name": "ARComponentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARComponentsV1",
"doc": "ARA Component collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "Id"
}, {
"name": "application_name",
"type": "string",
"doc": "Application name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "application_type",
"type": "string",
"doc": "Application type"
}, {
"name": "application_is_archived",
"type": "boolean",
"doc": "Application is archived"
}, {
"name": "application_creation_time",
"type": "string",
"doc": "Application creation time"
}, {
"name": "application_last_changed",
"type": "string",
"doc": "Application last changed"
}, {
"name": "component_name",
"type": "string",
"doc": "Component name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "component_type",
"type": "string",
"doc": "Component type"
}, {
"name": "app_id",
"type": "long",
"doc": "Application ID"
}, {
"name": "component_is_archived",
"type": "boolean",
"doc": "Component is archived"
}, {
"name": "component_creation_time",
"type": "string",
"doc": "Component creation time"
}, {
"name": "component_last_changed",
"type": "string",
"doc": "Component last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetPerAgentV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetPerAgentV1",
"doc": "ARA Deployment target Per Agent collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "name",
"type": "string",
"doc": "Name"
}, {
"name": "is_active",
"type": "boolean",
"doc": "Is active"
}, {
"name": "agent",
"type": "string",
"doc": "Agent name"
}, {
"name": "agent_type",
"type": "string",
"doc": "Agent type"
}, {
"name": "target_type",
"type": "string",
"doc": "Deployment Target type"
}, {
"name": "handler_id",
"type": "long",
"doc": "Deployment Target Handler ID"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Creation time"
}, {
"name": "last_changed",
"type": "string",
"doc": "Last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetsV1",
"doc": "ARA Deployment Target collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "environment_name",
"type": "string",
"doc": "Environment name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_type",
"type": "string",
"doc": "Environment type"
}, {
"name": "environment_is_archived",
"type": "boolean",
"doc": "Environment is archived"
}, {
"name": "environment_creation_time",
"type": "string",
"doc": "Environment creation time"
}, {
"name": "environment_last_changed",
"type": "string",
"doc": "Environment last changed"
}, {
"name": "target_name",
"type": "string",
"doc": "Target name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "target_type",
"type": "string",
"doc": "Target type"
}, {
"name": "target_active",
"type": "boolean",
"doc": "Target active"
}, {
"name": "target_is_archived",
"type": "boolean",
"doc": "Target is archived"
}, {
"name": "target_creation_time",
"type": "string",
"doc": "Target creation time"
}, {
"name": "target_last_changed",
"type": "string",
"doc": "Target last changed"
}, {
"name": "target_env_id",
"type": "long",
"doc": "Target Environment ID"
}
]
}, {
"type": "record",
"name": "ARPackagesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARPackagesV1",
"doc": "ARA Packages collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_name",
"type": "string",
"doc": "Package Name"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_state",
"type": "string",
"doc": "State of the package"
}, {
"name": "type_id",
"type": "long",
"doc": "Package Custom Type ID"
}, {
"name": "package_type",
"type": "string",
"doc": "Package Custom Type Name"
}, {
"name": "base_type",
"type": "int",
"doc": "Base Type of the package. 0=Generic, 1=Deployment"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the package is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the package has been created"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the package was changed the last time, i.e. state changed"
}, {
"name": "application_name",
"type": "string",
"doc": "name of the application which the package is belonging to",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}, {
"type": "record",
"name": "ARWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARWorkflowsV1",
"doc": "ARA Workflow collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Execution ID"
}, {
"name": "actual_from",
"type": "string",
"doc": "Deployment start time"
}, {
"name": "actual_to",
"type": "string",
"doc": "Deployment end time"
}, {
"name": "runtime_in_seconds",
"type": "int",
"doc": "Run time in seconds"
}, {
"name": "run_id",
"type": "int",
"doc": "Run ID in the Automation Engine"
}, {
"name": "status",
"type": "int",
"doc": "Current state of workflow executions. 0=WaitingApproval, 1=WaitingStartTime, 2=WaitingManualConfirm, 3=Active, 4=Blocked, 5=Rejected, 6=Revoked, 7=Canceled, 8=Finished, 9=Failed"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the workflow execution is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the execution has been created (either started or planned)"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the execution was changed the last time, i.e. state changed"
}, {
"name": "result",
"type": "int",
"doc": "Result of deployment history: 0=NA, 1=Failed, 2=Finished, 3=Canceled"
}, {
"name": "application_id",
"type": "long",
"doc": "Id of the Application that is being deployed by the Package"
}, {
"name": "application_name",
"type": "string",
"doc": "Application that is being deployed by the Package",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_id",
"type": "long",
"doc": "Id of the Environment that the Package is deployed to"
}, {
"name": "environment_name",
"type": "string",
"doc": "Name of the Environment that the Package is deployed to",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "patch_id",
"type": "string",
"doc": "ID of the package being patched by the package"
}, {
"name": "deployment_profile_id",
"type": "long",
"doc": "Id of the Deployment Profile"
}, {
"name": "deployment_profile_name",
"type": "string",
"doc": "Name of the Deployment Profile",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "deployment_descriptor_size",
"type": "int",
"doc": "Size of the deployment descriptor in byte"
}, {
"name": "queue_run_id",
"type": "long",
"doc": "Queue Run ID"
}, {
"name": "start_mode",
"type": "int",
"doc": "Execution start mode.0=Immediately, 1=ImmediatelyWithConfirmation, 2=AtPlannedTime, 3=AtPlannedTimeWithConfirmation = 3, 4=InQueue, 5=InQueueWithConfirmation"
}, {
"name": "workflow_mode",
"type": "int",
"doc": "Workflow mode. 0=Install, 1=Uninstall, 2=Other, 3=Provisioning"
}, {
"name": "installation_mode",
"type": "int",
"doc": "Installation mode. 0=Skip, 1=Override"
}
]
}, {
"type": "record",
"name": "MetricV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV2",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV3",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "OSMetricsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.OSMetricsV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agt_type",
"type": "string"
}, {
"name": "agt_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "mo_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "os_info",
"type": "string"
}, {
"name": "calc_period_sec",
"type": "int"
}, {
"name": "metrics_array",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "sldmetric",
"fields": [{
"name": "code",
"type": "string"
}, {
"name": "instance",
"type": "string"
}, {
"name": "avg_value",
"type": "double"
}, {
"name": "max_value",
"type": "double"
}, {
"name": "min_value",
"type": "double"
}, {
"name": "pct_info",
"type": "double"
}
]
}
}
}
]
}, {
"type": "record",
"name": "SnapshotV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV1",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV2",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV3",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}, {
"name": "snapshot_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "XXApeCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXApeCustomV1",
"doc": "Custom Metric (Automation Platform Environment)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXUiuCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXUiuCustomV1",
"doc": "Custom Metric (User Interface Usage)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWdfCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWdfCustomV1",
"doc": "Custom Metric (Workflow Definitions)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWecCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWecCustomV1",
"doc": "Custom Metric (Workflow Environment Context)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWexCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWexCustomV1",
"doc": "Custom Metric (Workflow Execution Statistics)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "DataExportStatus",
"namespace": "com.automic.analytics.telemetry.dataexport.dataexportstatus",
"fields": [{
"name": "status",
"type": "int",
"default": 0
}, {
"name": "message",
"type": "string",
"default": ""
}, {
"name": "stats",
"type": {
"type": "record",
"name": "Stats",
"fields": [{
"name": "exported_records",
"type": "long",
"default": -1
}, {
"name": "failed_records",
"type": "long",
"default": -1
}
]
},
"default": {}
}, {
"name": "manual_ack_data",
"type": {
"type": "record",
"name": "ManualAckData",
"fields": [{
"name": "last_offsets",
"type": {
"type": "map",
"values": {
"type": "map",
"values": "long"
}
},
"default": {}
}
]
},
"default": {}
}
]
}
]
Body
Media type: application/octet-stream
Type: application/octet-stream
post
Consume all data from starting points and up to end points specified in POST data with consumer ID specified in {id}.
post /telemetry/private-consumers/{id}/replay
Consume all data from starting points and up to end points specified in POST data with consumer ID specified in {id}.
URI Parameters
- id: required (string)
Consumer's ID.
Query Parameters
- sizelimitmb: (number)
Threshold of exported data size in Mb after which the export should stop to limit the size of the exported data file.
Example:
100 - manualacknowledge: (boolean)
Specifies whether acknowledgment should be done manually or automatically (default is false).
Example:
true
Body
Media type: application/json
Type:
{
"$ref" : "#/definitions/telemetry-dataexport-ReplayInfo",
"definitions" : {
"telemetry-dataexport-ReplayInfo" : {
"type" : "object",
"required" : [ "start_offsets", "last_offsets" ],
"additionalProperties" : false,
"properties" : {
"start_offsets" : {
"default" : { },
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : -9223372036854775808,
"maximum" : 9223372036854775807
}
}
},
"last_offsets" : {
"default" : { },
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : -9223372036854775808,
"maximum" : 9223372036854775807
}
}
}
}
}
}
}Examples:
With-end-boundaries:
{
"start_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 10
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 34
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 231
}
},
"last_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 355
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 40
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 901
}
}
}
Without-end-boundaries:
{
"start_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 10
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 34
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 231
}
},
"last_offsets": {
}
}
HTTP status code 200
Successful Response. File in Avro Object Container format. The header of the file will contain the following metadata:
- telemetry.ae_system_name
- telemetry.customer_id
- telemetry.analytics_backend_id
- telemetry.export_context
The last block in the file will contain a single status record of type DataExportStatus. The status and message of this record should be checked to determine whether the export was successful (status should be > 0).
The header of the file will also contain the Avro schema for the data in the file (some of the types in the union may not be available depending on how category export filtering is configured on the server):
[{
"type": "record",
"name": "AEAgentsPerCPV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsPerCPV1",
"doc": "AE Agents per CP",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "cp_name",
"type": "string",
"doc": "CP name"
}, {
"name": "connection_count",
"type": "int",
"doc": "Number of Agent connected to CP"
}
]
}, {
"type": "record",
"name": "AEAgentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEAgentsV1",
"doc": "AE Agents",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Agent Snapshot timestamp"
}, {
"name": "agent_name",
"type": "string",
"doc": "AE Agent name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "active",
"type": "int",
"doc": "PEER active = 1"
}, {
"name": "attr_type",
"type": "string",
"doc": "Attribute type corresponding to table UC_HTYP"
}, {
"name": "version",
"type": "string",
"doc": "Executor version"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "software",
"type": "string",
"doc": "Software"
}, {
"name": "software_vers",
"type": "string",
"doc": "Software version"
}, {
"name": "license_class",
"type": "string",
"doc": "License class"
}, {
"name": "lic_category",
"type": "string",
"doc": "License calegory"
}, {
"name": "net_area",
"type": "string",
"doc": "The NetArea in which this Agent runs"
}
]
}, {
"type": "record",
"name": "AEDbInfoV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEDbInfoV1",
"doc": "AE Db Info",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "vendor",
"type": "string"
}, {
"name": "version",
"type": "string"
}
]
}, {
"type": "record",
"name": "AEObjectsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEObjectsV1",
"doc": "AE Objects",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Object Snapshot timestamp"
}, {
"name": "client_id",
"type": "int",
"doc": "Client Id"
}, {
"name": "object_type",
"type": "string",
"doc": "Object Type"
}, {
"name": "object_count",
"type": "int",
"doc": "Object Count"
}
]
}, {
"type": "record",
"name": "AEPerfGlobalV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfGlobalV1",
"doc": "AE Performance management global metrics",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Overall Metric timestamp"
}, {
"name": "overall_metrics",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "OverallMetric",
"doc": "Overall metric",
"fields": [{
"name": "metric",
"type": "string",
"doc": "Overall Metric name"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}
},
"doc": "Array of all overall metrics"
}
]
}, {
"type": "record",
"name": "AEPerfIssuesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfIssuesV1",
"doc": "AE Performance management Issues",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Issue timestamp"
}, {
"name": "issue_idnr",
"type": "int",
"doc": "Issue idnr"
}, {
"name": "msg_insert",
"type": "string",
"doc": "Issue insert message"
}, {
"name": "quit_comment",
"type": "string",
"doc": "Quit comment"
}
]
}, {
"type": "record",
"name": "AEPerfProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEPerfProcessesV1",
"doc": "AE Performance Process management metric",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name. MsgDist: metric about message occurrences. TimevsDB: metric about used time and DB times. MsgTime: mean time of occurred message. MQLength: metric about the length of the message queue tables. MQCount: count of the message queues."
}, {
"name": "wp_name",
"type": "string",
"doc": "Process name"
}, {
"name": "tcpip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "srv_type",
"type": "int",
"doc": "Server type"
}, {
"name": "interval",
"type": "int",
"doc": "Interval"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A counter for the current metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Name of the metric counter"
}, {
"name": "value",
"type": "int",
"doc": "Value of the counter"
}
]
}
},
"doc": "Array of counters for the current metric"
}
]
}, {
"type": "record",
"name": "AEProcessesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEProcessesV1",
"doc": "AE Processes",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "AE Process Snapshot timestamp"
}, {
"name": "server_name",
"type": "string",
"doc": "Server name"
}, {
"name": "system",
"type": "string",
"doc": "AE system name"
}, {
"name": "ip_addr",
"type": "string",
"doc": "IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "port",
"type": "int",
"doc": "Port number"
}, {
"name": "type",
"type": "int",
"doc": "Process type (1=CP, 2=WP, 4=PWP, 8=Agent)"
}, {
"name": "start_time",
"type": "string",
"doc": "Process start date"
}, {
"name": "last_update",
"type": "string",
"doc": "Process update date"
}, {
"name": "ip_add2",
"type": "string",
"doc": "local IP address of the server",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "net_area",
"type": "string",
"doc": "Network area"
}, {
"name": "mq_set",
"type": "string",
"doc": "MQ set (1 for new MQ1* and 2 for new MQ2*)"
}, {
"name": "version",
"type": "string",
"doc": "AE version"
}
]
}, {
"type": "record",
"name": "AESysVarV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AESysVarV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "name",
"type": "string"
}, {
"name": "values",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Value",
"doc": "A container for key value pairs",
"fields": [{
"name": "key",
"type": "string",
"doc": "key"
}, {
"name": "value",
"type": "string",
"doc": "value"
}
]
}
},
"doc": "Array of key value pairs"
}
]
}, {
"type": "record",
"name": "AEWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.AEWorkflowsV1",
"doc": "AE Workflows data",
"fields": [{
"name": "run_id",
"type": "long",
"doc": "run identifier"
}, {
"name": "workflow_name",
"type": "string",
"doc": "Workflow name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "activation_time",
"type": "string",
"doc": "Activation timestamp"
}, {
"name": "start_time",
"type": "string",
"doc": "Start timestamp"
}, {
"name": "end_time",
"type": "string",
"doc": "end time (including post processing time if available)"
}, {
"name": "status",
"type": "long",
"doc": "state of the activity"
}, {
"name": "ert",
"type": "long",
"doc": "estimated runtime"
}
]
}, {
"type": "record",
"name": "ARComponentsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARComponentsV1",
"doc": "ARA Component collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "Id"
}, {
"name": "application_name",
"type": "string",
"doc": "Application name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "application_type",
"type": "string",
"doc": "Application type"
}, {
"name": "application_is_archived",
"type": "boolean",
"doc": "Application is archived"
}, {
"name": "application_creation_time",
"type": "string",
"doc": "Application creation time"
}, {
"name": "application_last_changed",
"type": "string",
"doc": "Application last changed"
}, {
"name": "component_name",
"type": "string",
"doc": "Component name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "component_type",
"type": "string",
"doc": "Component type"
}, {
"name": "app_id",
"type": "long",
"doc": "Application ID"
}, {
"name": "component_is_archived",
"type": "boolean",
"doc": "Component is archived"
}, {
"name": "component_creation_time",
"type": "string",
"doc": "Component creation time"
}, {
"name": "component_last_changed",
"type": "string",
"doc": "Component last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetPerAgentV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetPerAgentV1",
"doc": "ARA Deployment target Per Agent collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "name",
"type": "string",
"doc": "Name"
}, {
"name": "is_active",
"type": "boolean",
"doc": "Is active"
}, {
"name": "agent",
"type": "string",
"doc": "Agent name"
}, {
"name": "agent_type",
"type": "string",
"doc": "Agent type"
}, {
"name": "target_type",
"type": "string",
"doc": "Deployment Target type"
}, {
"name": "handler_id",
"type": "long",
"doc": "Deployment Target Handler ID"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Creation time"
}, {
"name": "last_changed",
"type": "string",
"doc": "Last changed"
}
]
}, {
"type": "record",
"name": "ARDeployTargetsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARDeployTargetsV1",
"doc": "ARA Deployment Target collector data",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Snapshot timestamp"
}, {
"name": "client_id",
"type": "string",
"doc": "client identifier"
}, {
"name": "id",
"type": "long",
"doc": "ID"
}, {
"name": "environment_name",
"type": "string",
"doc": "Environment name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_type",
"type": "string",
"doc": "Environment type"
}, {
"name": "environment_is_archived",
"type": "boolean",
"doc": "Environment is archived"
}, {
"name": "environment_creation_time",
"type": "string",
"doc": "Environment creation time"
}, {
"name": "environment_last_changed",
"type": "string",
"doc": "Environment last changed"
}, {
"name": "target_name",
"type": "string",
"doc": "Target name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "target_type",
"type": "string",
"doc": "Target type"
}, {
"name": "target_active",
"type": "boolean",
"doc": "Target active"
}, {
"name": "target_is_archived",
"type": "boolean",
"doc": "Target is archived"
}, {
"name": "target_creation_time",
"type": "string",
"doc": "Target creation time"
}, {
"name": "target_last_changed",
"type": "string",
"doc": "Target last changed"
}, {
"name": "target_env_id",
"type": "long",
"doc": "Target Environment ID"
}
]
}, {
"type": "record",
"name": "ARPackagesV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARPackagesV1",
"doc": "ARA Packages collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_name",
"type": "string",
"doc": "Package Name"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_state",
"type": "string",
"doc": "State of the package"
}, {
"name": "type_id",
"type": "long",
"doc": "Package Custom Type ID"
}, {
"name": "package_type",
"type": "string",
"doc": "Package Custom Type Name"
}, {
"name": "base_type",
"type": "int",
"doc": "Base Type of the package. 0=Generic, 1=Deployment"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the package is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the package has been created"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the package was changed the last time, i.e. state changed"
}, {
"name": "application_name",
"type": "string",
"doc": "name of the application which the package is belonging to",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}, {
"type": "record",
"name": "ARWorkflowsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.ARWorkflowsV1",
"doc": "ARA Workflow collector data",
"fields": [{
"name": "id",
"type": "long",
"doc": "Execution ID"
}, {
"name": "actual_from",
"type": "string",
"doc": "Deployment start time"
}, {
"name": "actual_to",
"type": "string",
"doc": "Deployment end time"
}, {
"name": "runtime_in_seconds",
"type": "int",
"doc": "Run time in seconds"
}, {
"name": "run_id",
"type": "int",
"doc": "Run ID in the Automation Engine"
}, {
"name": "status",
"type": "int",
"doc": "Current state of workflow executions. 0=WaitingApproval, 1=WaitingStartTime, 2=WaitingManualConfirm, 3=Active, 4=Blocked, 5=Rejected, 6=Revoked, 7=Canceled, 8=Finished, 9=Failed"
}, {
"name": "is_archived",
"type": "boolean",
"doc": "Indicates if the workflow execution is archived"
}, {
"name": "creation_time",
"type": "string",
"doc": "Date and time when the execution has been created (either started or planned)"
}, {
"name": "last_changed",
"type": "string",
"doc": "Date and time the execution was changed the last time, i.e. state changed"
}, {
"name": "result",
"type": "int",
"doc": "Result of deployment history: 0=NA, 1=Failed, 2=Finished, 3=Canceled"
}, {
"name": "application_id",
"type": "long",
"doc": "Id of the Application that is being deployed by the Package"
}, {
"name": "application_name",
"type": "string",
"doc": "Application that is being deployed by the Package",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "environment_id",
"type": "long",
"doc": "Id of the Environment that the Package is deployed to"
}, {
"name": "environment_name",
"type": "string",
"doc": "Name of the Environment that the Package is deployed to",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "package_id",
"type": "long",
"doc": "Package ID"
}, {
"name": "package_display_name",
"type": "string",
"doc": "Package display name",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "patch_id",
"type": "string",
"doc": "ID of the package being patched by the package"
}, {
"name": "deployment_profile_id",
"type": "long",
"doc": "Id of the Deployment Profile"
}, {
"name": "deployment_profile_name",
"type": "string",
"doc": "Name of the Deployment Profile",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "deployment_descriptor_size",
"type": "int",
"doc": "Size of the deployment descriptor in byte"
}, {
"name": "queue_run_id",
"type": "long",
"doc": "Queue Run ID"
}, {
"name": "start_mode",
"type": "int",
"doc": "Execution start mode.0=Immediately, 1=ImmediatelyWithConfirmation, 2=AtPlannedTime, 3=AtPlannedTimeWithConfirmation = 3, 4=InQueue, 5=InQueueWithConfirmation"
}, {
"name": "workflow_mode",
"type": "int",
"doc": "Workflow mode. 0=Install, 1=Uninstall, 2=Other, 3=Provisioning"
}, {
"name": "installation_mode",
"type": "int",
"doc": "Installation mode. 0=Skip, 1=Override"
}
]
}, {
"type": "record",
"name": "MetricV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV2",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}
]
}, {
"type": "record",
"name": "MetricV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.MetricV3",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agent_id",
"type": "string"
}, {
"name": "metric_code",
"type": "string"
}, {
"name": "metric_instance_name",
"type": "string"
}, {
"name": "average_value",
"type": "double"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "OSMetricsV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.OSMetricsV1",
"fields": [{
"name": "timestamp",
"type": "string"
}, {
"name": "agt_type",
"type": "string"
}, {
"name": "agt_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "mo_name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "os_info",
"type": "string"
}, {
"name": "calc_period_sec",
"type": "int"
}, {
"name": "metrics_array",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "sldmetric",
"fields": [{
"name": "code",
"type": "string"
}, {
"name": "instance",
"type": "string"
}, {
"name": "avg_value",
"type": "double"
}, {
"name": "max_value",
"type": "double"
}, {
"name": "min_value",
"type": "double"
}, {
"name": "pct_info",
"type": "double"
}
]
}
}
}
]
}, {
"type": "record",
"name": "SnapshotV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV1",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV2",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV2",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}
]
}, {
"type": "record",
"name": "SnapshotV3",
"namespace": "com.automic.analytics.telemetry.categories.schemas.SnapshotV3",
"fields": [{
"name": "name",
"type": "string",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "version",
"type": "string"
}, {
"name": "platform",
"type": "string"
}, {
"name": "hardware",
"type": "string"
}, {
"name": "software",
"type": "string"
}, {
"name": "software_version",
"type": "string"
}, {
"name": "ip",
"type": "string",
"anonymize": {
"rules": ["ruleSetIP"]
}
}, {
"name": "activate",
"type": "boolean"
}, {
"name": "port",
"type": "int"
}, {
"name": "ae_id",
"type": "string"
}, {
"name": "injection_date",
"type": "string"
}, {
"name": "snapshot_id",
"type": "string"
}
]
}, {
"type": "record",
"name": "XXApeCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXApeCustomV1",
"doc": "Custom Metric (Automation Platform Environment)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXUiuCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXUiuCustomV1",
"doc": "Custom Metric (User Interface Usage)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWdfCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWdfCustomV1",
"doc": "Custom Metric (Workflow Definitions)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWecCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWecCustomV1",
"doc": "Custom Metric (Workflow Environment Context)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "XXWexCustomV1",
"namespace": "com.automic.analytics.telemetry.categories.schemas.XXWexCustomV1",
"doc": "Custom Metric (Workflow Execution Statistics)",
"fields": [{
"name": "timestamp",
"type": "string",
"doc": "Metric timestamp"
}, {
"name": "metric",
"type": "string",
"doc": "Metric name"
}, {
"name": "version",
"type": "long",
"doc": "Version"
}, {
"name": "resource",
"type": "string",
"doc": "Resource"
}, {
"name": "anonymized_resource",
"type": "string",
"doc": "Anonymized Resource",
"anonymize": {
"rules": ["maskAllHash"]
}
}, {
"name": "properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "Property",
"doc": "A key/value property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Key Value"
}
]
}
},
"doc": "Properties for custom metric"
}, {
"name": "anonymized_properties",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "AnonymizedProperty",
"doc": "A key/value anonymized property for custom metric",
"fields": [{
"name": "key",
"type": "string",
"doc": "Key Name"
}, {
"name": "value",
"type": "string",
"doc": "Anonymized Key Value",
"anonymize": {
"rules": ["maskAllHash"]
}
}
]
}
},
"doc": "Anonymized Properties for custom metric"
}
]
}, {
"type": "record",
"name": "DataExportStatus",
"namespace": "com.automic.analytics.telemetry.dataexport.dataexportstatus",
"fields": [{
"name": "status",
"type": "int",
"default": 0
}, {
"name": "message",
"type": "string",
"default": ""
}, {
"name": "stats",
"type": {
"type": "record",
"name": "Stats",
"fields": [{
"name": "exported_records",
"type": "long",
"default": -1
}, {
"name": "failed_records",
"type": "long",
"default": -1
}
]
},
"default": {}
}, {
"name": "manual_ack_data",
"type": {
"type": "record",
"name": "ManualAckData",
"fields": [{
"name": "last_offsets",
"type": {
"type": "map",
"values": {
"type": "map",
"values": "long"
}
},
"default": {}
}
]
},
"default": {}
}
]
}
]
Body
Media type: application/octet-stream
Type: application/octet-stream
post
Perform acknowledgement for consumed data specified in POST data and with consumer ID specified in {id}.
post /telemetry/private-consumers/{id}/acknowledge
Perform acknowledgement for consumed data specified in POST data and with consumer ID specified in {id}.
URI Parameters
- id: required (string)
Consumer's ID.
Body
Media type: application/json
Type:
{
"$ref" : "#/definitions/telemetry-dataexport-AcknowledgeData",
"definitions" : {
"telemetry-dataexport-AcknowledgeData" : {
"type" : "object",
"required" : [ "last_offsets" ],
"additionalProperties" : false,
"properties" : {
"last_offsets" : {
"default" : { },
"type" : "object",
"additionalProperties" : {
"type" : "object",
"additionalProperties" : {
"type" : "integer",
"minimum" : -9223372036854775808,
"maximum" : 9223372036854775807
}
}
}
}
}
}
}Example:
{
"last_offsets": {
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEWorkflows": {
"0": 355
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEProcesses": {
"0": 40
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEDbInfo": {
"0": 0
},
"AUTOMIC_ac9df941-df80-472b-8cb5-ccd889240047_ds-telemetry_cat-AEObjects": {
"0": 901
}
}
}
HTTP status code 200
An empty body is returned.
Body
Media type: application/json
Type: application/json
Apikeys Resource
Manage scoped API keys.
get
Returns a list of defined scoped API keys.
post
Creates a new API key.
post /apikeys
Creates a new API key.
Body
Media type: application/json
Example:
{
"scope": "EVENTS",
"client": 100,
"description": "some text"
}
HTTP status code 200
Successful Response
Body
Media type: application/json
Example:
{
"key": "<UUID>",
"scope": "EVENTS",
"client": 100,
"description": "some text"
}
delete
Deletes a scoped API key.