@meshery/schemas 1.3.103 → 1.3.104
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.d.ts +186 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.js +1 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.js +25 -0
- package/dist/constructs/v1beta3/activity_metrics/ActivityMetricsSchema.mjs +25 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +1 -1
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +1 -1
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +1 -1
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +1 -1
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export type paths = Record<string, never>;
|
|
7
|
+
export type webhooks = Record<string, never>;
|
|
8
|
+
export interface components {
|
|
9
|
+
schemas: {
|
|
10
|
+
/**
|
|
11
|
+
* Activity Metrics Schema
|
|
12
|
+
* @description Server-returned per-activity reception figures for one post, as recorded
|
|
13
|
+
* in the `metadata` of an event on the events service (category `blowhorn`,
|
|
14
|
+
* action `activity_metrics`); the event construct carries the envelope and
|
|
15
|
+
* this construct names the metadata's own shape, which Event leaves open.
|
|
16
|
+
* One row is one activity as one export read it, identified by
|
|
17
|
+
* (organizationId, platform, activityRef, readingDate): a later export adds a
|
|
18
|
+
* reading rather than replacing an earlier one, so the rows are a time series
|
|
19
|
+
* and the reading with the latest readingDate is an activity's current
|
|
20
|
+
* figures. The events service appends and enforces no uniqueness, so
|
|
21
|
+
* re-importing an export records the same key twice: readers take, for each
|
|
22
|
+
* key, the most recently recorded event and must not sum duplicates. The figures come from a
|
|
23
|
+
* LinkedIn page content export's "All posts" sheet, whose header sits under
|
|
24
|
+
* a disclaimer row; readingDate is that export's date, the day the figures
|
|
25
|
+
* were true as of. `matched` records whether the row's link resolved to a
|
|
26
|
+
* stored content activity at import (through `content.promotion_link`,
|
|
27
|
+
* per-profile entries of an `all` row included); an unmatched row is kept,
|
|
28
|
+
* not dropped - the post was made outside Blowhorn and is still the page's
|
|
29
|
+
* reception. Every figure is nullable: a blank figure in the source export
|
|
30
|
+
* is not a zero.
|
|
31
|
+
*/
|
|
32
|
+
ActivityMetrics: {
|
|
33
|
+
/**
|
|
34
|
+
* Format: uuid
|
|
35
|
+
* @description Owning organization ID.
|
|
36
|
+
*/
|
|
37
|
+
organizationId: string;
|
|
38
|
+
/** @description The platform the activity was posted to (today only `linkedin` produces these exports). */
|
|
39
|
+
platform: string;
|
|
40
|
+
/** @description The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports. */
|
|
41
|
+
activityRef: string;
|
|
42
|
+
/**
|
|
43
|
+
* Format: date
|
|
44
|
+
* @description The export's date - the day the figures were read as of, as an ISO calendar date.
|
|
45
|
+
*/
|
|
46
|
+
readingDate: string;
|
|
47
|
+
/** @description The page the export belongs to, named as the source export names it. */
|
|
48
|
+
subject: string;
|
|
49
|
+
/** @description The post link as the export spelled it, before normalization to `activityRef`. */
|
|
50
|
+
link: string;
|
|
51
|
+
/** @description The post's title as the export gives it; null when the export names none. */
|
|
52
|
+
title?: string | null;
|
|
53
|
+
/** @description The post's type as the export gives it (for example `Organic`); null when the export names none. */
|
|
54
|
+
postType?: string | null;
|
|
55
|
+
/** @description Who the export says posted the activity; null when the export names none. */
|
|
56
|
+
postedBy?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* Format: date
|
|
59
|
+
* @description The day the activity was created, as an ISO calendar date; null when the export names none.
|
|
60
|
+
*/
|
|
61
|
+
createdDate?: string | null;
|
|
62
|
+
/** @description The audience the export names for the activity; null when it names none. */
|
|
63
|
+
audience?: string | null;
|
|
64
|
+
/** @description The content type the export names for the activity; null when it names none. */
|
|
65
|
+
contentType?: string | null;
|
|
66
|
+
/** @description Impressions the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
67
|
+
impressions?: number | null;
|
|
68
|
+
/** @description Views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
69
|
+
views?: number | null;
|
|
70
|
+
/** @description Offsite views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
71
|
+
offsiteViews?: number | null;
|
|
72
|
+
/** @description Clicks the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
73
|
+
clicks?: number | null;
|
|
74
|
+
/**
|
|
75
|
+
* Format: double
|
|
76
|
+
* @description Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
77
|
+
*/
|
|
78
|
+
clickThroughRate?: number | null;
|
|
79
|
+
/** @description Likes the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
80
|
+
likes?: number | null;
|
|
81
|
+
/** @description Comments the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
82
|
+
comments?: number | null;
|
|
83
|
+
/** @description Reposts the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
84
|
+
reposts?: number | null;
|
|
85
|
+
/** @description Follows the activity had produced by the reading date; null when the export's cell is blank. */
|
|
86
|
+
follows?: number | null;
|
|
87
|
+
/**
|
|
88
|
+
* Format: double
|
|
89
|
+
* @description Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
90
|
+
*/
|
|
91
|
+
engagementRate?: number | null;
|
|
92
|
+
/** @description Whether the activity's link resolved to a stored content activity at import. */
|
|
93
|
+
matched: boolean;
|
|
94
|
+
/** @description The content row the activity matched, when it matched; null for an unmatched activity. */
|
|
95
|
+
contentRow?: number | null;
|
|
96
|
+
/** @description The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched. */
|
|
97
|
+
contentProfile?: string | null;
|
|
98
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
99
|
+
sourceFile: string;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Activity Metrics Payload Schema
|
|
103
|
+
* @description Payload for recording one activity's reception figures as of one export,
|
|
104
|
+
* sent as the `metadata` of a create-event call. Contains only
|
|
105
|
+
* client-settable fields; the row has no server-generated fields, because
|
|
106
|
+
* the events service stores and returns event metadata verbatim, so the
|
|
107
|
+
* payload and the recorded row (ActivityMetrics) share one field set.
|
|
108
|
+
*/
|
|
109
|
+
ActivityMetricsPayload: {
|
|
110
|
+
/**
|
|
111
|
+
* Format: uuid
|
|
112
|
+
* @description Owning organization ID.
|
|
113
|
+
*/
|
|
114
|
+
organizationId: string;
|
|
115
|
+
/** @description The platform the activity was posted to (today only `linkedin` produces these exports). */
|
|
116
|
+
platform: string;
|
|
117
|
+
/** @description The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports. */
|
|
118
|
+
activityRef: string;
|
|
119
|
+
/**
|
|
120
|
+
* Format: date
|
|
121
|
+
* @description The export's date - the day the figures were read as of, as an ISO calendar date.
|
|
122
|
+
*/
|
|
123
|
+
readingDate: string;
|
|
124
|
+
/** @description The page the export belongs to, named as the source export names it. */
|
|
125
|
+
subject: string;
|
|
126
|
+
/** @description The post link as the export spelled it, before normalization to `activityRef`. */
|
|
127
|
+
link: string;
|
|
128
|
+
/** @description The post's title as the export gives it; null when the export names none. */
|
|
129
|
+
title?: string | null;
|
|
130
|
+
/** @description The post's type as the export gives it (for example `Organic`); null when the export names none. */
|
|
131
|
+
postType?: string | null;
|
|
132
|
+
/** @description Who the export says posted the activity; null when the export names none. */
|
|
133
|
+
postedBy?: string | null;
|
|
134
|
+
/**
|
|
135
|
+
* Format: date
|
|
136
|
+
* @description The day the activity was created, as an ISO calendar date; null when the export names none.
|
|
137
|
+
*/
|
|
138
|
+
createdDate?: string | null;
|
|
139
|
+
/** @description The audience the export names for the activity; null when it names none. */
|
|
140
|
+
audience?: string | null;
|
|
141
|
+
/** @description The content type the export names for the activity; null when it names none. */
|
|
142
|
+
contentType?: string | null;
|
|
143
|
+
/** @description Impressions the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
144
|
+
impressions?: number | null;
|
|
145
|
+
/** @description Views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
146
|
+
views?: number | null;
|
|
147
|
+
/** @description Offsite views the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
148
|
+
offsiteViews?: number | null;
|
|
149
|
+
/** @description Clicks the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
150
|
+
clicks?: number | null;
|
|
151
|
+
/**
|
|
152
|
+
* Format: double
|
|
153
|
+
* @description Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
154
|
+
*/
|
|
155
|
+
clickThroughRate?: number | null;
|
|
156
|
+
/** @description Likes the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
157
|
+
likes?: number | null;
|
|
158
|
+
/** @description Comments the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
159
|
+
comments?: number | null;
|
|
160
|
+
/** @description Reposts the activity had gathered by the reading date; null when the export's cell is blank. */
|
|
161
|
+
reposts?: number | null;
|
|
162
|
+
/** @description Follows the activity had produced by the reading date; null when the export's cell is blank. */
|
|
163
|
+
follows?: number | null;
|
|
164
|
+
/**
|
|
165
|
+
* Format: double
|
|
166
|
+
* @description Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.
|
|
167
|
+
*/
|
|
168
|
+
engagementRate?: number | null;
|
|
169
|
+
/** @description Whether the activity's link resolved to a stored content activity at import. */
|
|
170
|
+
matched: boolean;
|
|
171
|
+
/** @description The content row the activity matched, when it matched; null for an unmatched activity. */
|
|
172
|
+
contentRow?: number | null;
|
|
173
|
+
/** @description The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched. */
|
|
174
|
+
contentProfile?: string | null;
|
|
175
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
176
|
+
sourceFile: string;
|
|
177
|
+
};
|
|
178
|
+
};
|
|
179
|
+
responses: never;
|
|
180
|
+
parameters: never;
|
|
181
|
+
requestBodies: never;
|
|
182
|
+
headers: never;
|
|
183
|
+
pathItems: never;
|
|
184
|
+
}
|
|
185
|
+
export type $defs = Record<string, never>;
|
|
186
|
+
export type operations = Record<string, never>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Activity Metrics",description:"OpenAPI schema for per-activity reception figures for one post,\nconsumed by Blowhorn's analytics store. The rows have no endpoints of\ntheir own: they are recorded and read back as the `metadata` of events\non the events service (category `blowhorn`, action `activity_metrics`;\nsee the event construct), so this file declares the components only and\nthe paths stay with the event construct.\n",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{ActivityMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Schema",description:`Server-returned per-activity reception figures for one post, as recorded
|
|
2
|
+
in the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`activity_metrics\`); the event construct carries the envelope and
|
|
4
|
+
this construct names the metadata's own shape, which Event leaves open.
|
|
5
|
+
One row is one activity as one export read it, identified by
|
|
6
|
+
(organizationId, platform, activityRef, readingDate): a later export adds a
|
|
7
|
+
reading rather than replacing an earlier one, so the rows are a time series
|
|
8
|
+
and the reading with the latest readingDate is an activity's current
|
|
9
|
+
figures. The events service appends and enforces no uniqueness, so
|
|
10
|
+
re-importing an export records the same key twice: readers take, for each
|
|
11
|
+
key, the most recently recorded event and must not sum duplicates. The figures come from a
|
|
12
|
+
LinkedIn page content export's "All posts" sheet, whose header sits under
|
|
13
|
+
a disclaimer row; readingDate is that export's date, the day the figures
|
|
14
|
+
were true as of. \`matched\` records whether the row's link resolved to a
|
|
15
|
+
stored content activity at import (through \`content.promotion_link\`,
|
|
16
|
+
per-profile entries of an \`all\` row included); an unmatched row is kept,
|
|
17
|
+
not dropped - the post was made outside Blowhorn and is still the page's
|
|
18
|
+
reception. Every figure is nullable: a blank figure in the source export
|
|
19
|
+
is not a zero.
|
|
20
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports.","x-oapi-codegen-extra-tags":{db:"activity_ref"},"x-order":3},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":5},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`.","x-oapi-codegen-extra-tags":{db:"link"},"x-order":6},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none.","x-oapi-codegen-extra-tags":{db:"title"},"x-order":7},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none.","x-oapi-codegen-extra-tags":{db:"post_type"},"x-order":8},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none.","x-oapi-codegen-extra-tags":{db:"posted_by"},"x-order":9},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none.","x-oapi-codegen-extra-tags":{db:"created_date"},"x-order":10},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"audience"},"x-order":11},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"content_type"},"x-order":12},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions"},"x-order":13},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"views"},"x-order":14},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"offsite_views"},"x-order":15},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks"},"x-order":16},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"click_through_rate"},"x-order":17},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"likes"},"x-order":18},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments"},"x-order":19},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts"},"x-order":20},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"follows"},"x-order":21},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"engagement_rate"},"x-order":22},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import.","x-oapi-codegen-extra-tags":{db:"matched"},"x-order":23},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity.","x-oapi-codegen-extra-tags":{db:"content_row"},"x-order":24},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched.","x-oapi-codegen-extra-tags":{db:"content_profile"},"x-order":25},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":26}}},ActivityMetricsPayload:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Payload Schema",description:`Payload for recording one activity's reception figures as of one export,
|
|
21
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
22
|
+
client-settable fields; the row has no server-generated fields, because
|
|
23
|
+
the events service stores and returns event metadata verbatim, so the
|
|
24
|
+
payload and the recorded row (ActivityMetrics) share one field set.
|
|
25
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports)."},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports."},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date."},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it."},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`."},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none."},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none."},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none."},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none."},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none."},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none."},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank."},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank."},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank."},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank."},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank."},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank."},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank."},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import."},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity."},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched."},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Activity Metrics",description:"OpenAPI schema for per-activity reception figures for one post,\nconsumed by Blowhorn's analytics store. The rows have no endpoints of\ntheir own: they are recorded and read back as the `metadata` of events\non the events service (category `blowhorn`, action `activity_metrics`;\nsee the event construct), so this file declares the components only and\nthe paths stay with the event construct.\n",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{ActivityMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Schema",description:`Server-returned per-activity reception figures for one post, as recorded
|
|
2
|
+
in the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`activity_metrics\`); the event construct carries the envelope and
|
|
4
|
+
this construct names the metadata's own shape, which Event leaves open.
|
|
5
|
+
One row is one activity as one export read it, identified by
|
|
6
|
+
(organizationId, platform, activityRef, readingDate): a later export adds a
|
|
7
|
+
reading rather than replacing an earlier one, so the rows are a time series
|
|
8
|
+
and the reading with the latest readingDate is an activity's current
|
|
9
|
+
figures. The events service appends and enforces no uniqueness, so
|
|
10
|
+
re-importing an export records the same key twice: readers take, for each
|
|
11
|
+
key, the most recently recorded event and must not sum duplicates. The figures come from a
|
|
12
|
+
LinkedIn page content export's "All posts" sheet, whose header sits under
|
|
13
|
+
a disclaimer row; readingDate is that export's date, the day the figures
|
|
14
|
+
were true as of. \`matched\` records whether the row's link resolved to a
|
|
15
|
+
stored content activity at import (through \`content.promotion_link\`,
|
|
16
|
+
per-profile entries of an \`all\` row included); an unmatched row is kept,
|
|
17
|
+
not dropped - the post was made outside Blowhorn and is still the page's
|
|
18
|
+
reception. Every figure is nullable: a blank figure in the source export
|
|
19
|
+
is not a zero.
|
|
20
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports.","x-oapi-codegen-extra-tags":{db:"activity_ref"},"x-order":3},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":5},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`.","x-oapi-codegen-extra-tags":{db:"link"},"x-order":6},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none.","x-oapi-codegen-extra-tags":{db:"title"},"x-order":7},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none.","x-oapi-codegen-extra-tags":{db:"post_type"},"x-order":8},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none.","x-oapi-codegen-extra-tags":{db:"posted_by"},"x-order":9},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none.","x-oapi-codegen-extra-tags":{db:"created_date"},"x-order":10},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"audience"},"x-order":11},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none.","x-oapi-codegen-extra-tags":{db:"content_type"},"x-order":12},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions"},"x-order":13},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"views"},"x-order":14},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"offsite_views"},"x-order":15},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks"},"x-order":16},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"click_through_rate"},"x-order":17},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"likes"},"x-order":18},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments"},"x-order":19},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts"},"x-order":20},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"follows"},"x-order":21},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"engagement_rate"},"x-order":22},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import.","x-oapi-codegen-extra-tags":{db:"matched"},"x-order":23},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity.","x-oapi-codegen-extra-tags":{db:"content_row"},"x-order":24},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched.","x-oapi-codegen-extra-tags":{db:"content_profile"},"x-order":25},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":26}}},ActivityMetricsPayload:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Metrics Payload Schema",description:`Payload for recording one activity's reception figures as of one export,
|
|
21
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
22
|
+
client-settable fields; the row has no server-generated fields, because
|
|
23
|
+
the events service stores and returns event metadata verbatim, so the
|
|
24
|
+
payload and the recorded row (ActivityMetrics) share one field set.
|
|
25
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","activityRef","readingDate","subject","link","matched","sourceFile"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",maxLength:64,description:"The platform the activity was posted to (today only `linkedin` produces these exports)."},activityRef:{type:"string",maxLength:255,description:"The activity's platform identifier, normalized to its URN (`urn:li:activity:<id>`, `urn:li:share:<id>` or `urn:li:ugcPost:<id>`) so the encoded and plain spellings of one link agree. The URN kind is kept, so one post reached as both an activity URN and a share URN is two activityRefs; the exports name each post by one link, so readings of the same post line up across exports."},readingDate:{type:"string",format:"date",description:"The export's date - the day the figures were read as of, as an ISO calendar date."},subject:{type:"string",maxLength:255,description:"The page the export belongs to, named as the source export names it."},link:{type:"string",maxLength:2048,description:"The post link as the export spelled it, before normalization to `activityRef`."},title:{type:"string",maxLength:3e3,nullable:true,description:"The post's title as the export gives it; null when the export names none."},postType:{type:"string",maxLength:64,nullable:true,description:"The post's type as the export gives it (for example `Organic`); null when the export names none."},postedBy:{type:"string",maxLength:255,nullable:true,description:"Who the export says posted the activity; null when the export names none."},createdDate:{type:"string",format:"date",nullable:true,description:"The day the activity was created, as an ISO calendar date; null when the export names none."},audience:{type:"string",maxLength:255,nullable:true,description:"The audience the export names for the activity; null when it names none."},contentType:{type:"string",maxLength:64,nullable:true,description:"The content type the export names for the activity; null when it names none."},impressions:{type:"integer",nullable:true,minimum:0,description:"Impressions the activity had gathered by the reading date; null when the export's cell is blank."},views:{type:"integer",nullable:true,minimum:0,description:"Views the activity had gathered by the reading date; null when the export's cell is blank."},offsiteViews:{type:"integer",nullable:true,minimum:0,description:"Offsite views the activity had gathered by the reading date; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"Clicks the activity had gathered by the reading date; null when the export's cell is blank."},clickThroughRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Click-through rate as a fraction (0.05 is 5%); null when the export's cell is blank."},likes:{type:"integer",nullable:true,minimum:0,description:"Likes the activity had gathered by the reading date; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"Comments the activity had gathered by the reading date; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"Reposts the activity had gathered by the reading date; null when the export's cell is blank."},follows:{type:"integer",nullable:true,minimum:0,description:"Follows the activity had produced by the reading date; null when the export's cell is blank."},engagementRate:{type:"number",format:"double",nullable:true,minimum:0,description:"Engagement rate as a fraction (0.05 is 5%); null when the export's cell is blank."},matched:{type:"boolean",description:"Whether the activity's link resolved to a stored content activity at import."},contentRow:{type:"integer",nullable:true,minimum:0,description:"The content row the activity matched, when it matched; null for an unmatched activity."},contentProfile:{type:"string",maxLength:255,nullable:true,description:"The profile whose promotion link matched, for a matched activity shared by several profiles; null when no single profile matched."},sourceFile:{type:"string",maxLength:1024,description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
|
|
@@ -13,4 +13,4 @@ nullable: a blank cell is not a zero.
|
|
|
13
13
|
the \`metadata\` of a create-event call. Contains only client-settable
|
|
14
14
|
fields; the row has no server-generated fields, because the events
|
|
15
15
|
service stores and returns event metadata verbatim, so the payload
|
|
16
|
-
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|
|
16
|
+
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|
|
@@ -13,4 +13,4 @@ nullable: a blank cell is not a zero.
|
|
|
13
13
|
the \`metadata\` of a create-event call. Contains only client-settable
|
|
14
14
|
fields; the row has no server-generated fields, because the events
|
|
15
15
|
service stores and returns event metadata verbatim, so the payload
|
|
16
|
-
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
|
|
16
|
+
and the recorded row (ContentMetrics) share one field set.`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank."},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank."},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank."},uniqueImpressions:{type:"integer",nullable:true,minimum:0,description:"Unique impressions that day (the export reports this figure for organic only); null when the export's cell is blank."},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank."},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank."},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank."},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank."},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank."},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank."},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank."},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank."},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank."},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank."},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank."},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank."},engagementRateOrganic:{type:"number",nullable:true,minimum:0,description:"Organic engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRateSponsored:{type:"number",nullable:true,minimum:0,description:"Sponsored engagement rate that day, as the export reports it; null when the export's cell is blank."},engagementRate:{type:"number",nullable:true,minimum:0,description:"Overall engagement rate that day, as the export reports it; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
|
|
@@ -22,4 +22,4 @@ only client-settable fields; the row has no server-generated
|
|
|
22
22
|
fields, because the events service stores and returns event
|
|
23
23
|
metadata verbatim, so the payload and the recorded row
|
|
24
24
|
(FollowerDemographics) share one field set.
|
|
25
|
-
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date."},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries."},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name)."},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},o=e;module.exports=o;
|
|
25
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date."},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries."},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name)."},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},o=e;module.exports=o;
|
|
@@ -22,4 +22,4 @@ only client-settable fields; the row has no server-generated
|
|
|
22
22
|
fields, because the events service stores and returns event
|
|
23
23
|
metadata verbatim, so the payload and the recorded row
|
|
24
24
|
(FollowerDemographics) share one field set.
|
|
25
|
-
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date."},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries."},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name)."},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},o=e;export{o as default};
|
|
25
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date."},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries."},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name)."},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},o=e;export{o as default};
|
|
@@ -13,4 +13,4 @@ client-settable fields; the row has no server-generated fields,
|
|
|
13
13
|
because the events service stores and returns event metadata
|
|
14
14
|
verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
15
15
|
share one field set.
|
|
16
|
-
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank."},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank."},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank."},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|
|
16
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank."},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank."},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank."},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|
|
@@ -13,4 +13,4 @@ client-settable fields; the row has no server-generated fields,
|
|
|
13
13
|
because the events service stores and returns event metadata
|
|
14
14
|
verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
15
15
|
share one field set.
|
|
16
|
-
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank."},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank."},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank."},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
|
|
16
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID"},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank."},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank."},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank."},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@meshery/schemas",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.104",
|
|
4
4
|
"description": "<p style=\"text-align:center;\" align=\"center\"><a href=\"https://meshery.io\"><picture> <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg\"> <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\"> <img src=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\" alt=\"Meshery Logo\" width=\"70%\" /></picture></a><br /><br /></p> <p align=\"center\"> <a href=\"https://hub.docker.com/r/meshery/meshery\" alt=\"Docker pulls\"> <img src=\"https://img.shields.io/docker/pulls/meshery/meshery.svg\" /></a> <a href=\"https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%meshery+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+\" alt=\"GitHub issues by-label\"> <img src=\"https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational\" /></a> <a href=\"https://github.com/meshery/meshery/blob/master/LICENSE\" alt=\"LICENSE\"> <img src=\"https://img.shields.io/github/license/meshery/meshery?color=brightgreen\" /></a> <a href=\"https://artifacthub.io/packages/helm/meshery/meshery\" alt=\"Artifact Hub Meshery\"> <img src=\"https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub\" /></a> <a href=\"https://goreportcard.com/report/github.com/meshery/meshery\" alt=\"Go Report Card\"> <img src=\"https://goreportcard.com/badge/github.com/meshery/meshery\" /></a> <a href=\"https://github.com/meshery/meshery/actions\" alt=\"Build Status\"> <img src=\"https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml\" /></a> <a href=\"https://bestpractices.coreinfrastructure.org/projects/3564\" alt=\"CLI Best Practices\"> <img src=\"https://bestpractices.coreinfrastructure.org/projects/3564/badge\" /></a> <a href=\"http://discuss.meshery.io\" alt=\"Discuss Users\"> <img src=\"https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io\" /></a> <a href=\"https://slack.meshery.io\" alt=\"Join Slack\"> <img src=\"https://img.shields.io/badge/Slack-@meshery.svg?logo=slack\" /></a> <a href=\"https://twitter.com/intent/follow?screen_name=mesheryio\" alt=\"Twitter Follow\"> <img src=\"https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social\" /></a> <a href=\"https://github.com/meshery/meshery/releases\" alt=\"Meshery Downloads\"> <img src=\"https://img.shields.io/github/downloads/meshery/meshery/total\" /></a> <!-- <a href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield\" alt=\"License Scan Report\"> <img src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield\"/></a> --> </p>",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|