@meshery/schemas 1.3.97 → 1.3.98
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/cloudApi.d.mts +207 -185
- package/dist/cloudApi.d.ts +207 -185
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/content_metrics/ContentMetrics.d.ts +151 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetrics.js +1 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +16 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +16 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographics.d.ts +94 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographics.js +1 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographics.mjs +0 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +25 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +25 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetrics.d.ts +90 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetrics.js +1 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +16 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +16 -0
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +157 -11
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +19 -27
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +19 -27
- package/dist/constructs/v1beta3/token/Token.d.ts +17 -77
- package/dist/constructs/v1beta3/token/TokenSchema.js +3 -3
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +3 -3
- package/package.json +1 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Content Metrics",description:"OpenAPI schema for daily content figures for a page, consumed by\nBlowhorn's analytics store. The rows have no endpoints of their own:\nthey are recorded and read back as the `metadata` of events on the\nevents service (category `blowhorn`, action `content_metrics`; see\nthe event construct), so this file declares the components only and\nthe paths stay with the event construct.",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:{ContentMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Metrics Schema",description:`Server-returned daily content figures for one page, as recorded in the
|
|
2
|
+
\`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`content_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 page on one day, keyed by (organizationId, platform,
|
|
6
|
+
subject, readingDate): the day's impressions, clicks, reactions,
|
|
7
|
+
comments and reposts, each split organic / sponsored alongside its
|
|
8
|
+
total, plus the engagement rates the source export reports. A figure
|
|
9
|
+
exists only when the export carries its column \u2014 an export without a
|
|
10
|
+
sponsored breakdown records no sponsored figures \u2014 and every figure is
|
|
11
|
+
nullable: a blank cell is not a zero.
|
|
12
|
+
`,type:"object",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","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions_organic"},"x-order":5},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions_sponsored"},"x-order":6},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions"},"x-order":7},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.","x-oapi-codegen-extra-tags":{db:"unique_impressions"},"x-order":8},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks_organic"},"x-order":9},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks_sponsored"},"x-order":10},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks"},"x-order":11},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reactions_organic"},"x-order":12},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reactions_sponsored"},"x-order":13},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reactions"},"x-order":14},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments_organic"},"x-order":15},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments_sponsored"},"x-order":16},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments"},"x-order":17},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts_organic"},"x-order":18},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts_sponsored"},"x-order":19},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts"},"x-order":20},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.","x-oapi-codegen-extra-tags":{db:"engagement_rate_organic"},"x-order":21},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.","x-oapi-codegen-extra-tags":{db:"engagement_rate_sponsored"},"x-order":22},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.","x-oapi-codegen-extra-tags":{db:"engagement_rate"},"x-order":23},sourceFile:{type:"string",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":24}}},ContentMetricsPayload:{type:"object",description:`Payload for recording one day's content figures for a page, sent as
|
|
13
|
+
the \`metadata\` of a create-event call. Contains only client-settable
|
|
14
|
+
fields; the row has no server-generated fields, because the events
|
|
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;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Content Metrics",description:"OpenAPI schema for daily content figures for a page, consumed by\nBlowhorn's analytics store. The rows have no endpoints of their own:\nthey are recorded and read back as the `metadata` of events on the\nevents service (category `blowhorn`, action `content_metrics`; see\nthe event construct), so this file declares the components only and\nthe paths stay with the event construct.",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:{ContentMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Metrics Schema",description:`Server-returned daily content figures for one page, as recorded in the
|
|
2
|
+
\`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`content_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 page on one day, keyed by (organizationId, platform,
|
|
6
|
+
subject, readingDate): the day's impressions, clicks, reactions,
|
|
7
|
+
comments and reposts, each split organic / sponsored alongside its
|
|
8
|
+
total, plus the engagement rates the source export reports. A figure
|
|
9
|
+
exists only when the export carries its column \u2014 an export without a
|
|
10
|
+
sponsored breakdown records no sponsored figures \u2014 and every figure is
|
|
11
|
+
nullable: a blank cell is not a zero.
|
|
12
|
+
`,type:"object",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","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},impressionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic impressions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions_organic"},"x-order":5},impressionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored impressions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions_sponsored"},"x-order":6},impressions:{type:"integer",nullable:true,minimum:0,description:"All impressions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"impressions"},"x-order":7},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.","x-oapi-codegen-extra-tags":{db:"unique_impressions"},"x-order":8},clicksOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic clicks that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks_organic"},"x-order":9},clicksSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored clicks that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks_sponsored"},"x-order":10},clicks:{type:"integer",nullable:true,minimum:0,description:"All clicks that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"clicks"},"x-order":11},reactionsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reactions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reactions_organic"},"x-order":12},reactionsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reactions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reactions_sponsored"},"x-order":13},reactions:{type:"integer",nullable:true,minimum:0,description:"All reactions that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reactions"},"x-order":14},commentsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic comments that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments_organic"},"x-order":15},commentsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored comments that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments_sponsored"},"x-order":16},comments:{type:"integer",nullable:true,minimum:0,description:"All comments that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"comments"},"x-order":17},repostsOrganic:{type:"integer",nullable:true,minimum:0,description:"Organic reposts that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts_organic"},"x-order":18},repostsSponsored:{type:"integer",nullable:true,minimum:0,description:"Sponsored reposts that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts_sponsored"},"x-order":19},reposts:{type:"integer",nullable:true,minimum:0,description:"All reposts that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"reposts"},"x-order":20},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.","x-oapi-codegen-extra-tags":{db:"engagement_rate_organic"},"x-order":21},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.","x-oapi-codegen-extra-tags":{db:"engagement_rate_sponsored"},"x-order":22},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.","x-oapi-codegen-extra-tags":{db:"engagement_rate"},"x-order":23},sourceFile:{type:"string",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":24}}},ContentMetricsPayload:{type:"object",description:`Payload for recording one day's content figures for a page, sent as
|
|
13
|
+
the \`metadata\` of a create-event call. Contains only client-settable
|
|
14
|
+
fields; the row has no server-generated fields, because the events
|
|
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};
|
|
@@ -0,0 +1,94 @@
|
|
|
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
|
+
* Follower Demographics Schema
|
|
12
|
+
* @description Server-returned follower-breakdown snapshot row for one page, as
|
|
13
|
+
* recorded in the `metadata` of an event on the events service (category
|
|
14
|
+
* `blowhorn`, action `follower_demographics`); the event construct carries
|
|
15
|
+
* the envelope and this construct names the metadata's own shape, which
|
|
16
|
+
* Event leaves open. One row is one category of one breakdown of one page
|
|
17
|
+
* on one day, keyed by (organizationId, platform, subject, readingDate,
|
|
18
|
+
* dimension, category): the page's follower total on that snapshot day
|
|
19
|
+
* falls into exactly one category of each dimension, so a dimension's
|
|
20
|
+
* categories sum to the page's total. `followers` is a cumulative count
|
|
21
|
+
* on the day, not a daily change, and is nullable: a blank figure in the
|
|
22
|
+
* source export is not a zero.
|
|
23
|
+
*/
|
|
24
|
+
FollowerDemographics: {
|
|
25
|
+
/**
|
|
26
|
+
* Format: uuid
|
|
27
|
+
* @description Owning organization ID.
|
|
28
|
+
*/
|
|
29
|
+
organizationId: string;
|
|
30
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
31
|
+
platform: string;
|
|
32
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
33
|
+
subject: string;
|
|
34
|
+
/**
|
|
35
|
+
* Format: date
|
|
36
|
+
* @description The day the snapshot describes, as an ISO calendar date.
|
|
37
|
+
*/
|
|
38
|
+
readingDate: string;
|
|
39
|
+
/**
|
|
40
|
+
* @description The breakdown the category belongs to; one value per breakdown sheet the source export carries.
|
|
41
|
+
* @enum {string}
|
|
42
|
+
*/
|
|
43
|
+
dimension: "location" | "job_function" | "seniority" | "industry" | "company_size";
|
|
44
|
+
/** @description The breakdown row's label, verbatim from the source export (e.g. a location or an industry name). */
|
|
45
|
+
category: string;
|
|
46
|
+
/** @description The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank. */
|
|
47
|
+
followers?: number | null;
|
|
48
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
49
|
+
sourceFile?: string;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* @description Payload for recording one follower-breakdown snapshot row for a
|
|
53
|
+
* page, sent as the `metadata` of a create-event call. Contains
|
|
54
|
+
* only client-settable fields; the row has no server-generated
|
|
55
|
+
* fields, because the events service stores and returns event
|
|
56
|
+
* metadata verbatim, so the payload and the recorded row
|
|
57
|
+
* (FollowerDemographics) share one field set.
|
|
58
|
+
*/
|
|
59
|
+
FollowerDemographicsPayload: {
|
|
60
|
+
/**
|
|
61
|
+
* Format: uuid
|
|
62
|
+
* @description Owning organization ID.
|
|
63
|
+
*/
|
|
64
|
+
organizationId: string;
|
|
65
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
66
|
+
platform: string;
|
|
67
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
68
|
+
subject: string;
|
|
69
|
+
/**
|
|
70
|
+
* Format: date
|
|
71
|
+
* @description The day the snapshot describes, as an ISO calendar date.
|
|
72
|
+
*/
|
|
73
|
+
readingDate: string;
|
|
74
|
+
/**
|
|
75
|
+
* @description The breakdown the category belongs to; one value per breakdown sheet the source export carries.
|
|
76
|
+
* @enum {string}
|
|
77
|
+
*/
|
|
78
|
+
dimension: "location" | "job_function" | "seniority" | "industry" | "company_size";
|
|
79
|
+
/** @description The breakdown row's label, verbatim from the source export (e.g. a location or an industry name). */
|
|
80
|
+
category: string;
|
|
81
|
+
/** @description The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank. */
|
|
82
|
+
followers?: number | null;
|
|
83
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
84
|
+
sourceFile?: string;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
responses: never;
|
|
88
|
+
parameters: never;
|
|
89
|
+
requestBodies: never;
|
|
90
|
+
headers: never;
|
|
91
|
+
pathItems: never;
|
|
92
|
+
}
|
|
93
|
+
export type $defs = Record<string, never>;
|
|
94
|
+
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:"Follower Demographics",description:`OpenAPI schema for follower-breakdown snapshot rows for a page,
|
|
2
|
+
consumed by Blowhorn's analytics store. The rows have no endpoints
|
|
3
|
+
of their own: they are recorded and read back as the \`metadata\` of
|
|
4
|
+
events on the events service (category \`blowhorn\`, action
|
|
5
|
+
\`follower_demographics\`; see the event construct), so this file
|
|
6
|
+
declares the components only and the paths stay with the event
|
|
7
|
+
construct.
|
|
8
|
+
`,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 [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerDemographics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Demographics Schema",description:`Server-returned follower-breakdown snapshot row for one page, as
|
|
9
|
+
recorded in the \`metadata\` of an event on the events service (category
|
|
10
|
+
\`blowhorn\`, action \`follower_demographics\`); the event construct carries
|
|
11
|
+
the envelope and this construct names the metadata's own shape, which
|
|
12
|
+
Event leaves open. One row is one category of one breakdown of one page
|
|
13
|
+
on one day, keyed by (organizationId, platform, subject, readingDate,
|
|
14
|
+
dimension, category): the page's follower total on that snapshot day
|
|
15
|
+
falls into exactly one category of each dimension, so a dimension's
|
|
16
|
+
categories sum to the page's total. \`followers\` is a cumulative count
|
|
17
|
+
on the day, not a daily change, and is nullable: a blank figure in the
|
|
18
|
+
source export is not a zero.
|
|
19
|
+
`,type:"object",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","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},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.","x-oapi-codegen-extra-tags":{db:"dimension"},"x-order":5},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name).","x-oapi-codegen-extra-tags":{db:"category"},"x-order":6},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.","x-oapi-codegen-extra-tags":{db:"followers"},"x-order":7},sourceFile:{type:"string",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":8}}},FollowerDemographicsPayload:{type:"object",description:`Payload for recording one follower-breakdown snapshot row for a
|
|
20
|
+
page, sent as the \`metadata\` of a create-event call. Contains
|
|
21
|
+
only client-settable fields; the row has no server-generated
|
|
22
|
+
fields, because the events service stores and returns event
|
|
23
|
+
metadata verbatim, so the payload and the recorded row
|
|
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;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Follower Demographics",description:`OpenAPI schema for follower-breakdown snapshot rows for a page,
|
|
2
|
+
consumed by Blowhorn's analytics store. The rows have no endpoints
|
|
3
|
+
of their own: they are recorded and read back as the \`metadata\` of
|
|
4
|
+
events on the events service (category \`blowhorn\`, action
|
|
5
|
+
\`follower_demographics\`; see the event construct), so this file
|
|
6
|
+
declares the components only and the paths stay with the event
|
|
7
|
+
construct.
|
|
8
|
+
`,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 [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerDemographics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Demographics Schema",description:`Server-returned follower-breakdown snapshot row for one page, as
|
|
9
|
+
recorded in the \`metadata\` of an event on the events service (category
|
|
10
|
+
\`blowhorn\`, action \`follower_demographics\`); the event construct carries
|
|
11
|
+
the envelope and this construct names the metadata's own shape, which
|
|
12
|
+
Event leaves open. One row is one category of one breakdown of one page
|
|
13
|
+
on one day, keyed by (organizationId, platform, subject, readingDate,
|
|
14
|
+
dimension, category): the page's follower total on that snapshot day
|
|
15
|
+
falls into exactly one category of each dimension, so a dimension's
|
|
16
|
+
categories sum to the page's total. \`followers\` is a cumulative count
|
|
17
|
+
on the day, not a daily change, and is nullable: a blank figure in the
|
|
18
|
+
source export is not a zero.
|
|
19
|
+
`,type:"object",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","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},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.","x-oapi-codegen-extra-tags":{db:"dimension"},"x-order":5},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name).","x-oapi-codegen-extra-tags":{db:"category"},"x-order":6},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.","x-oapi-codegen-extra-tags":{db:"followers"},"x-order":7},sourceFile:{type:"string",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":8}}},FollowerDemographicsPayload:{type:"object",description:`Payload for recording one follower-breakdown snapshot row for a
|
|
20
|
+
page, sent as the \`metadata\` of a create-event call. Contains
|
|
21
|
+
only client-settable fields; the row has no server-generated
|
|
22
|
+
fields, because the events service stores and returns event
|
|
23
|
+
metadata verbatim, so the payload and the recorded row
|
|
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};
|
|
@@ -0,0 +1,90 @@
|
|
|
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
|
+
* Follower Metrics Schema
|
|
12
|
+
* @description Server-returned daily new-follower figures for one page, as recorded in
|
|
13
|
+
* the `metadata` of an event on the events service (category `blowhorn`,
|
|
14
|
+
* action `follower_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 page on one day, keyed by (organizationId, platform,
|
|
17
|
+
* subject, readingDate): the day's NEW followers split by the source that
|
|
18
|
+
* produced them. The source export's "Total followers" column is a day's
|
|
19
|
+
* total of new followers, not a lifetime count. Every figure is nullable:
|
|
20
|
+
* a blank figure in the source export is not a zero.
|
|
21
|
+
*/
|
|
22
|
+
FollowerMetrics: {
|
|
23
|
+
/**
|
|
24
|
+
* Format: uuid
|
|
25
|
+
* @description Owning organization ID.
|
|
26
|
+
*/
|
|
27
|
+
organizationId: string;
|
|
28
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
29
|
+
platform: string;
|
|
30
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
31
|
+
subject: string;
|
|
32
|
+
/**
|
|
33
|
+
* Format: date
|
|
34
|
+
* @description The day the figures describe, as an ISO calendar date.
|
|
35
|
+
*/
|
|
36
|
+
readingDate: string;
|
|
37
|
+
/** @description New followers that day from sponsored content; null when the export's cell is blank. */
|
|
38
|
+
newSponsored?: number | null;
|
|
39
|
+
/** @description New followers that day from organic content; null when the export's cell is blank. */
|
|
40
|
+
newOrganic?: number | null;
|
|
41
|
+
/** @description New followers that day from auto-invites; null when the export's cell is blank. */
|
|
42
|
+
newAutoInvited?: number | null;
|
|
43
|
+
/** @description All new followers that day; null when the export's cell is blank. */
|
|
44
|
+
newTotal?: number | null;
|
|
45
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
46
|
+
sourceFile?: string;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* @description Payload for recording one day's new-follower figures for a page,
|
|
50
|
+
* sent as the `metadata` of a create-event call. Contains only
|
|
51
|
+
* client-settable fields; the row has no server-generated fields,
|
|
52
|
+
* because the events service stores and returns event metadata
|
|
53
|
+
* verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
54
|
+
* share one field set.
|
|
55
|
+
*/
|
|
56
|
+
FollowerMetricsPayload: {
|
|
57
|
+
/**
|
|
58
|
+
* Format: uuid
|
|
59
|
+
* @description Owning organization ID.
|
|
60
|
+
*/
|
|
61
|
+
organizationId: string;
|
|
62
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
63
|
+
platform: string;
|
|
64
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
65
|
+
subject: string;
|
|
66
|
+
/**
|
|
67
|
+
* Format: date
|
|
68
|
+
* @description The day the figures describe, as an ISO calendar date.
|
|
69
|
+
*/
|
|
70
|
+
readingDate: string;
|
|
71
|
+
/** @description New followers that day from sponsored content; null when the export's cell is blank. */
|
|
72
|
+
newSponsored?: number | null;
|
|
73
|
+
/** @description New followers that day from organic content; null when the export's cell is blank. */
|
|
74
|
+
newOrganic?: number | null;
|
|
75
|
+
/** @description New followers that day from auto-invites; null when the export's cell is blank. */
|
|
76
|
+
newAutoInvited?: number | null;
|
|
77
|
+
/** @description All new followers that day; null when the export's cell is blank. */
|
|
78
|
+
newTotal?: number | null;
|
|
79
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
80
|
+
sourceFile?: string;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
responses: never;
|
|
84
|
+
parameters: never;
|
|
85
|
+
requestBodies: never;
|
|
86
|
+
headers: never;
|
|
87
|
+
pathItems: never;
|
|
88
|
+
}
|
|
89
|
+
export type $defs = Record<string, never>;
|
|
90
|
+
export type operations = Record<string, never>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Follower Metrics",description:"OpenAPI schema for daily new-follower figures for a page, consumed by\nBlowhorn's analytics store. The rows have no endpoints of their own:\nthey are recorded and read back as the `metadata` of events on the\nevents service (category `blowhorn`, action `follower_metrics`; see\nthe 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 [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Metrics Schema",description:`Server-returned daily new-follower figures for one page, as recorded in
|
|
2
|
+
the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`follower_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 page on one day, keyed by (organizationId, platform,
|
|
6
|
+
subject, readingDate): the day's NEW followers split by the source that
|
|
7
|
+
produced them. The source export's "Total followers" column is a day's
|
|
8
|
+
total of new followers, not a lifetime count. Every figure is nullable:
|
|
9
|
+
a blank figure in the source export is not a zero.
|
|
10
|
+
`,type:"object",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","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_sponsored"},"x-order":5},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_organic"},"x-order":6},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_auto_invited"},"x-order":7},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_total"},"x-order":8},sourceFile:{type:"string",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":9}}},FollowerMetricsPayload:{type:"object",description:`Payload for recording one day's new-follower figures for a page,
|
|
11
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
12
|
+
client-settable fields; the row has no server-generated fields,
|
|
13
|
+
because the events service stores and returns event metadata
|
|
14
|
+
verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
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;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Follower Metrics",description:"OpenAPI schema for daily new-follower figures for a page, consumed by\nBlowhorn's analytics store. The rows have no endpoints of their own:\nthey are recorded and read back as the `metadata` of events on the\nevents service (category `blowhorn`, action `follower_metrics`; see\nthe 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 [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Metrics Schema",description:`Server-returned daily new-follower figures for one page, as recorded in
|
|
2
|
+
the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`follower_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 page on one day, keyed by (organizationId, platform,
|
|
6
|
+
subject, readingDate): the day's NEW followers split by the source that
|
|
7
|
+
produced them. The source export's "Total followers" column is a day's
|
|
8
|
+
total of new followers, not a lifetime count. Every figure is nullable:
|
|
9
|
+
a blank figure in the source export is not a zero.
|
|
10
|
+
`,type:"object",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","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_sponsored"},"x-order":5},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_organic"},"x-order":6},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_auto_invited"},"x-order":7},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_total"},"x-order":8},sourceFile:{type:"string",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":9}}},FollowerMetricsPayload:{type:"object",description:`Payload for recording one day's new-follower figures for a page,
|
|
11
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
12
|
+
client-settable fields; the row has no server-generated fields,
|
|
13
|
+
because the events service stores and returns event metadata
|
|
14
|
+
verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
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};
|