From c0e47af377e5b854254fda9dcf1d3fd94400f99d Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:32:28 -0700 Subject: [PATCH 1/8] Adding insgihts metrics global schema for RT CDP insights --- .../aep-insight-metrics.example.1.json | 12 ++++ .../aep-insight-metrics.schema.json | 72 +++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 schemas/insights-metrics/aep-insight-metrics.example.1.json create mode 100644 schemas/insights-metrics/aep-insight-metrics.schema.json diff --git a/schemas/insights-metrics/aep-insight-metrics.example.1.json b/schemas/insights-metrics/aep-insight-metrics.example.1.json new file mode 100644 index 0000000000..cd2c611458 --- /dev/null +++ b/schemas/insights-metrics/aep-insight-metrics.example.1.json @@ -0,0 +1,12 @@ +{ + "xdm:destinationMetrics": { + "xdm:destinationID": "df8d079d-11eb-466a-9731-6b5948a009e4", + "xdm:segmentID": "0f4ac2cd-a007-4e18-af2b-20c3dd64a8a2", + "xdm:flowRunID": "2e7e3e43-f144-49eb-aa03-35cedd2257e2", + "xdm:flowCompletedTime": "2022-06-06T15:52:25+00:00", + "xdm:flowRunStatus": "success", + "xdm:totalProfilesActivated": 340059.00, + "xdm:totalIdentitiesSkipped": 21093332.00, + "xdm:totalIdentitiesActivated": 12352011.00 + } +} diff --git a/schemas/insights-metrics/aep-insight-metrics.schema.json b/schemas/insights-metrics/aep-insight-metrics.schema.json new file mode 100644 index 0000000000..0baf8e1f8c --- /dev/null +++ b/schemas/insights-metrics/aep-insight-metrics.schema.json @@ -0,0 +1,72 @@ +{ + "meta:license": [ + "Copyright 2022 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile/aep-insights-metrics", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "AEP Insights Metrics", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/summary-metrics"], + "description": "Use this Schema to add summary metrics for various AEP services like Activations, Destinations, schema etc.", + "definitions": { + "insights-metrics": { + "properties": { + "xdm:destinationMetrics": { + "type": "object", + "description": "Captures metrics related to various destinations on AEP.", + "properties": { + "xdm:flowRunID": { + "title": "Flow Run ID", + "type": "string", + "description": "Flow run identifier to uniquely identify a flow which was triggered when a segment was activated over a destination." + }, + "xdm:flowCompletedTime": { + "title": "Flow Completed Time", + "type": "string", + "format": "date-time", + "description": "The date and time when the flow was completed. It could be blank or NULL if the flow was not successful." + }, + "xdm:flowRunStatus": { + "title": "Flow Run Status", + "type": "string", + "description": "The status of flow run. This could be success/partial-success/failed etc." + }, + "xdm:totalProfilesActivated": { + "title": "Total Profiles Activated", + "type": "number", + "description": "Total number of profiles activated summarized at the granularity of provided dimensions in this record." + }, + "xdm:totalIdentitiesSkipped": { + "title": "Total Identities Skipped", + "type": "number", + "description": "Total number of identities skipped summarized at the granularity of provided dimensions in this record." + }, + "xdm:totalIdentitiesActivated": { + "title": "Total Identities Activated", + "type": "number", + "description": "Total number of identities activated summarized at the granularity of provided dimensions in this record." + } + + } + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/insights-metrics" + }, + { + "$ref": "https://ns.adobe.com/xdm/classes/summary-metrics" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/destination-segment" + } + ], + "meta:status": "stable" +} From 08fbe1245cfca6263eceddabfb25d77f58064b03 Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:36:14 -0700 Subject: [PATCH 2/8] Adding insgihts metrics global schema for RT CDP insights --- schemas/insights-metrics/aep-insight-metrics.example.1.json | 6 +++--- schemas/insights-metrics/aep-insight-metrics.schema.json | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/schemas/insights-metrics/aep-insight-metrics.example.1.json b/schemas/insights-metrics/aep-insight-metrics.example.1.json index cd2c611458..6a1852068a 100644 --- a/schemas/insights-metrics/aep-insight-metrics.example.1.json +++ b/schemas/insights-metrics/aep-insight-metrics.example.1.json @@ -5,8 +5,8 @@ "xdm:flowRunID": "2e7e3e43-f144-49eb-aa03-35cedd2257e2", "xdm:flowCompletedTime": "2022-06-06T15:52:25+00:00", "xdm:flowRunStatus": "success", - "xdm:totalProfilesActivated": 340059.00, - "xdm:totalIdentitiesSkipped": 21093332.00, - "xdm:totalIdentitiesActivated": 12352011.00 + "xdm:totalProfilesActivated": 340059.0, + "xdm:totalIdentitiesSkipped": 21093332.0, + "xdm:totalIdentitiesActivated": 12352011.0 } } diff --git a/schemas/insights-metrics/aep-insight-metrics.schema.json b/schemas/insights-metrics/aep-insight-metrics.schema.json index 0baf8e1f8c..375d807070 100644 --- a/schemas/insights-metrics/aep-insight-metrics.schema.json +++ b/schemas/insights-metrics/aep-insight-metrics.schema.json @@ -51,7 +51,6 @@ "type": "number", "description": "Total number of identities activated summarized at the granularity of provided dimensions in this record." } - } } } @@ -66,7 +65,7 @@ }, { "$ref": "https://ns.adobe.com/xdm/context/destination-segment" - } + } ], "meta:status": "stable" } From f0c45b967dbccc48083b7f59b892a2a771c2d73a Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:40:54 -0700 Subject: [PATCH 3/8] Adding insgihts metrics global schema for RT CDP insights --- schemas/insights-metrics/aep-insight-metrics.schema.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/schemas/insights-metrics/aep-insight-metrics.schema.json b/schemas/insights-metrics/aep-insight-metrics.schema.json index 375d807070..6b5fbb03e8 100644 --- a/schemas/insights-metrics/aep-insight-metrics.schema.json +++ b/schemas/insights-metrics/aep-insight-metrics.schema.json @@ -5,13 +5,12 @@ "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id": "https://ns.adobe.com/xdm/mixins/profile/aep-insights-metrics", + "$id": "https://ns.adobe.com/xdm/schemas/aep-insights-metrics", "$schema": "http://json-schema.org/draft-06/schema#", "title": "AEP Insights Metrics", "type": "object", "meta:extensible": false, "meta:abstract": false, - "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/summary-metrics"], "description": "Use this Schema to add summary metrics for various AEP services like Activations, Destinations, schema etc.", "definitions": { "insights-metrics": { From 9ded977de175acf5d0a8d10be846f381c7882189 Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:46:12 -0700 Subject: [PATCH 4/8] Adding insgihts metrics global schema for RT CDP insights --- schemas/insights-metrics/aep-insight-metrics.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schemas/insights-metrics/aep-insight-metrics.schema.json b/schemas/insights-metrics/aep-insight-metrics.schema.json index 6b5fbb03e8..b2244779d5 100644 --- a/schemas/insights-metrics/aep-insight-metrics.schema.json +++ b/schemas/insights-metrics/aep-insight-metrics.schema.json @@ -60,7 +60,7 @@ "$ref": "#/definitions/insights-metrics" }, { - "$ref": "https://ns.adobe.com/xdm/classes/summary-metrics" + "$ref": "https://ns.adobe.com/xdm/classes/summarymetrics" }, { "$ref": "https://ns.adobe.com/xdm/context/destination-segment" From a46dd34b7a79d68db65e9e040a73ec0eb882c1f9 Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:48:21 -0700 Subject: [PATCH 5/8] Adding insgihts metrics global schema for RT CDP insights --- schemas/insights-metrics/aep-insight-metrics.example.1.json | 1 + 1 file changed, 1 insertion(+) diff --git a/schemas/insights-metrics/aep-insight-metrics.example.1.json b/schemas/insights-metrics/aep-insight-metrics.example.1.json index 6a1852068a..4c247b8127 100644 --- a/schemas/insights-metrics/aep-insight-metrics.example.1.json +++ b/schemas/insights-metrics/aep-insight-metrics.example.1.json @@ -1,5 +1,6 @@ { "xdm:destinationMetrics": { + "xdm:timeStamp": "2022-06-06T15:52:25+00:00", "xdm:destinationID": "df8d079d-11eb-466a-9731-6b5948a009e4", "xdm:segmentID": "0f4ac2cd-a007-4e18-af2b-20c3dd64a8a2", "xdm:flowRunID": "2e7e3e43-f144-49eb-aa03-35cedd2257e2", From 2d40ebc475599fbffae10e4548443111d1db03f1 Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:49:59 -0700 Subject: [PATCH 6/8] Adding insgihts metrics global schema for RT CDP insights --- schemas/insights-metrics/aep-insight-metrics.example.1.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schemas/insights-metrics/aep-insight-metrics.example.1.json b/schemas/insights-metrics/aep-insight-metrics.example.1.json index 4c247b8127..6b0fc5cde0 100644 --- a/schemas/insights-metrics/aep-insight-metrics.example.1.json +++ b/schemas/insights-metrics/aep-insight-metrics.example.1.json @@ -1,6 +1,6 @@ { "xdm:destinationMetrics": { - "xdm:timeStamp": "2022-06-06T15:52:25+00:00", + "xdm:timestamp": "2022-06-06T15:52:25+00:00", "xdm:destinationID": "df8d079d-11eb-466a-9731-6b5948a009e4", "xdm:segmentID": "0f4ac2cd-a007-4e18-af2b-20c3dd64a8a2", "xdm:flowRunID": "2e7e3e43-f144-49eb-aa03-35cedd2257e2", From 42d2c08f4f8e919e037334692357a6d43890db0c Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:52:52 -0700 Subject: [PATCH 7/8] Adding insgihts metrics global schema for RT CDP insights --- schemas/insights-metrics/aep-insight-metrics.example.1.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schemas/insights-metrics/aep-insight-metrics.example.1.json b/schemas/insights-metrics/aep-insight-metrics.example.1.json index 6b0fc5cde0..46fff01c12 100644 --- a/schemas/insights-metrics/aep-insight-metrics.example.1.json +++ b/schemas/insights-metrics/aep-insight-metrics.example.1.json @@ -1,6 +1,6 @@ { + "xdm:timestamp": "2022-06-06T15:52:25+00:00", "xdm:destinationMetrics": { - "xdm:timestamp": "2022-06-06T15:52:25+00:00", "xdm:destinationID": "df8d079d-11eb-466a-9731-6b5948a009e4", "xdm:segmentID": "0f4ac2cd-a007-4e18-af2b-20c3dd64a8a2", "xdm:flowRunID": "2e7e3e43-f144-49eb-aa03-35cedd2257e2", From b47563471e9e9647ef80d4fccc6a186a5159c16c Mon Sep 17 00:00:00 2001 From: mjasrotia <54868864+mjasrotia@users.noreply.github.com> Date: Wed, 8 Jun 2022 10:08:39 -0700 Subject: [PATCH 8/8] Added segment dimension for insights metrics --- .../aep-insight-metrics.schema.json | 25 ++++++- .../dim-segment.example.1.json | 7 ++ .../insights-metrics/dim-segment.schema.json | 73 +++++++++++++++++++ 3 files changed, 102 insertions(+), 3 deletions(-) create mode 100644 schemas/insights-metrics/dim-segment.example.1.json create mode 100644 schemas/insights-metrics/dim-segment.schema.json diff --git a/schemas/insights-metrics/aep-insight-metrics.schema.json b/schemas/insights-metrics/aep-insight-metrics.schema.json index b2244779d5..266a8c800f 100644 --- a/schemas/insights-metrics/aep-insight-metrics.schema.json +++ b/schemas/insights-metrics/aep-insight-metrics.schema.json @@ -51,6 +51,28 @@ "description": "Total number of identities activated summarized at the granularity of provided dimensions in this record." } } + }, + "xdm:segment": { + "type": "object", + "description": "Segment dimension properties.", + "properties": { + "xdm:ID": { + "title": "Segment Identifier", + "type": "string", + "description": "Unique identifier of the segment." + } + } + }, + "xdm:destination": { + "type": "object", + "description": "Destination dimension properties.", + "properties": { + "xdm:ID": { + "title": "Destination Identifier", + "type": "string", + "description": "Unique identifier of the Destination." + } + } } } } @@ -61,9 +83,6 @@ }, { "$ref": "https://ns.adobe.com/xdm/classes/summarymetrics" - }, - { - "$ref": "https://ns.adobe.com/xdm/context/destination-segment" } ], "meta:status": "stable" diff --git a/schemas/insights-metrics/dim-segment.example.1.json b/schemas/insights-metrics/dim-segment.example.1.json new file mode 100644 index 0000000000..8690ea8cef --- /dev/null +++ b/schemas/insights-metrics/dim-segment.example.1.json @@ -0,0 +1,7 @@ +{ + "xdm:segment": { + "xdm:ID": "0f4ac2cd-a007-4e18-af2b-20c3dd64a8a2", + "xdm:name": "Users with TV segment", + "xdm:status": "ACTIVE" + } +} diff --git a/schemas/insights-metrics/dim-segment.schema.json b/schemas/insights-metrics/dim-segment.schema.json new file mode 100644 index 0000000000..17569129ac --- /dev/null +++ b/schemas/insights-metrics/dim-segment.schema.json @@ -0,0 +1,73 @@ +{ + "meta:license": [ + "Copyright 2022 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/dim-segment", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment Dimension", + "type": "object", + "meta:extensible": false, + "meta:abstract": false, + "description": "This is the dimension schema for a segment definition which includes required fields like segment ID and name of segment.", + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "definitions": { + "segment": { + "properties": { + "xdm:segment": { + "type": "object", + "description": "Segment Dimension and its properties.", + "properties": { + "xdm:ID": { + "title": "Segment Identifier", + "type": "string", + "description": "Unique identifier of the segment." + }, + "xdm:name": { + "title": "Segment name", + "type": "string", + "description": "Name of the segment." + }, + "xdm:description": { + "title": "Segment description", + "type": "string", + "description": "Description of the segment." + }, + "xdm:source": { + "title": "Segment Source", + "type": "string", + "description": "Segment source indicating whether the segment was sent from an internal or external source." + }, + "xdm:namespace": { + "title": "Segment Namespace", + "type": "string", + "description": "Segment namespace." + }, + "xdm:version": { + "title": "Segment version", + "type": "string", + "description": "Version of the segment." + }, + "xdm:status": { + "type": "string", + "title": "Segment status", + "description": "Current status of segment from external system normalized to active, inactive, deleted, draft or revoked.", + "enum": ["ACTIVE", "INACTIVE", "DELETED", "DRAFT", "REVOKED"] + } + } + } + } + } + }, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/segment" + } + ], + "meta:status": "stable" +}