@meshery/schemas 1.3.73 → 1.3.75
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 +2 -2
- package/dist/cloudApi.d.ts +2 -2
- package/dist/constructs/v1beta3/activity_result/ActivityResult.d.ts +914 -0
- package/dist/constructs/v1beta3/activity_result/ActivityResult.js +1 -0
- package/dist/constructs/v1beta3/activity_result/ActivityResult.mjs +0 -0
- package/dist/constructs/v1beta3/activity_result/ActivityResultSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/activity_result/ActivityResultSchema.js +134 -0
- package/dist/constructs/v1beta3/activity_result/ActivityResultSchema.mjs +134 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +3 -3
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"ActivityResult",description:`OpenAPI schema for the result of one activity: delivery per profile and
|
|
2
|
+
platform, reception where it is collected, and derived follower context.
|
|
3
|
+
Contract only; it declares no endpoints. Clients that assemble a result
|
|
4
|
+
locally (a command line, a desktop panel) and a server that later serves
|
|
5
|
+
it share these types.
|
|
6
|
+
`,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:{schemas:{ActivityResult:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Result Schema",description:`The result of one activity: whether it went out on each platform and for
|
|
7
|
+
each profile it was addressed to, how it was received where reception is
|
|
8
|
+
collected, and the follower change around it. One entry per profile and
|
|
9
|
+
platform. Every figure says whether it was measured or derived, and
|
|
10
|
+
anything not collected says so with a reason instead of a zero.
|
|
11
|
+
`,type:"object",additionalProperties:false,required:["activityId","kind","platform","generatedAt","entries"],properties:{activityId:{type:"string",description:"Identifier of the activity the result describes (for a content piece, its row number as a string).",minLength:1,maxLength:255,"x-order":1},kind:{type:"string",description:"What the activity does, such as post, repost, comment, like, connect or invite.",minLength:1,maxLength:64,"x-order":2},platform:{type:"string",description:"Platform the activity targets (for example linkedin, x, bluesky).",minLength:1,maxLength:64,"x-order":3},title:{type:"string",description:"Short human-readable preview of the activity.",maxLength:512,"x-order":4},state:{type:"string",description:"The activity's queue state when the result was read (for example done, partial, pending, scheduled, draft).",maxLength:64,"x-order":5},generatedAt:{description:"When this result was assembled.","x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},entries:{type:"array",description:"One entry per profile and platform the activity is addressed to.",items:{type:"object",description:"The result of an activity for one profile on one platform.",additionalProperties:false,required:["profile","platform","delivery","reception","followerChange"],properties:{profile:{type:"string",description:"Profile the entry is for.",minLength:1,maxLength:255},platform:{type:"string",description:"Platform the entry is for.",minLength:1,maxLength:64},delivery:{type:"object",description:`Whether the activity went out for this profile and platform, from the
|
|
12
|
+
recorded outcome and the run log. Measured, never derived.
|
|
13
|
+
`,additionalProperties:false,required:["status","evidence"],properties:{status:{type:"string",description:`delivered (it went out), unconfirmed (the action was taken but its
|
|
14
|
+
outcome could not be read), failed (the last attempt failed and it
|
|
15
|
+
has not gone out), scheduled (due later), pending (due and not yet
|
|
16
|
+
run), draft (not approved, so it will not run).
|
|
17
|
+
`,enum:["delivered","unconfirmed","failed","scheduled","pending","draft"]},evidence:{type:"string",description:`What the status rests on: recorded (the outcome stored on the
|
|
18
|
+
activity), run (a run log entry), or none (nothing has happened yet).
|
|
19
|
+
`,enum:["recorded","run","none"]},deliveredAt:{type:"string",format:"date-time",description:"When it went out, as recorded.",nullable:true},scheduledFor:{type:"string",format:"date-time",description:"When it is due, for a scheduled or pending activity.",nullable:true},link:{type:"string",description:"Link to the live item on the platform.",maxLength:2048,nullable:true},computer:{type:"string",description:"Host name of the computer whose run delivered or attempted it.",maxLength:255,nullable:true},browserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},runId:{type:"string",description:"Run log identifier of the run that delivered or attempted it.",maxLength:255,nullable:true},attemptedAt:{type:"string",format:"date-time",description:"When the matched run ended.",nullable:true},durationSeconds:{type:"number",description:"How long the matched run took.",minimum:0,nullable:true},error:{type:"string",description:"The error the last failed attempt reported.",maxLength:4096,nullable:true},fix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},logPath:{type:"string",description:"Log file of the matched run, on the computer that ran it.",maxLength:2048,nullable:true}}},reception:{type:"object",description:`How the activity was received. Measured figures with the date they were
|
|
20
|
+
read, or collected false with a reason. Never zeros for missing data.
|
|
21
|
+
`,additionalProperties:false,required:["collected","measured"],properties:{collected:{type:"boolean",description:"Whether any reception figures exist for this entry."},measured:{type:"boolean",description:"Always true; reception figures are read from the platform, not computed."},reason:{type:"string",description:`Why reception is not collected: platform (nothing collects reception
|
|
22
|
+
for this platform yet), notdelivered (it has not gone out),
|
|
23
|
+
nolink (no live link to match on), notmatched (no collected figures
|
|
24
|
+
match its link yet), unavailable (the store does not hold reception
|
|
25
|
+
figures).
|
|
26
|
+
`,enum:["platform","notdelivered","nolink","notmatched","unavailable"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page the figures belong to.",maxLength:255},source:{type:"string",description:"Where the figures came from, for example a platform analytics export.",maxLength:255},asOf:{type:"string",format:"date",description:"Date the figures were read; they do not change after it.",nullable:true},metrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
27
|
+
null when the source did not report them, never zero. A
|
|
28
|
+
platform-specific figure not listed here is carried under its own key
|
|
29
|
+
only when it was reported.
|
|
30
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},comparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
31
|
+
other activities: the median of each figure and this activity's ratio
|
|
32
|
+
to it. Null when there are too few other activities to compare with.
|
|
33
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
34
|
+
null when the source did not report them, never zero. A
|
|
35
|
+
platform-specific figure not listed here is carried under its own key
|
|
36
|
+
only when it was reported.
|
|
37
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
38
|
+
null when the source did not report them, never zero. A
|
|
39
|
+
platform-specific figure not listed here is carried under its own key
|
|
40
|
+
only when it was reported.
|
|
41
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}}}},followerChange:{type:"object",description:`Derived. The subject's follower count at the reading before the activity
|
|
42
|
+
and the first reading at least the stated number of days after it.
|
|
43
|
+
Correlation only; it does not claim the activity caused the change.
|
|
44
|
+
`,additionalProperties:false,required:["collected","derived"],properties:{collected:{type:"boolean",description:"Whether follower readings exist on both sides of the activity."},derived:{type:"boolean",description:"Always true; the change is computed from two measured readings."},reason:{type:"string",description:`Why there is no change: platform (followers are not collected for
|
|
45
|
+
this subject's platform), notdelivered, noreadings (no reading on
|
|
46
|
+
one side of the activity yet).
|
|
47
|
+
`,enum:["platform","notdelivered","noreadings"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page whose followers were read.",maxLength:255},formula:{type:"string",description:"How the change is computed.",maxLength:512},windowDays:{type:"integer",description:"Days after the activity the later reading is taken from, at least.",minimum:0},before:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},after:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},change:{type:"integer",description:"after.followers minus before.followers.",nullable:true}}}}},"x-order":7}}},ActivityResultEntry:{type:"object",description:"The result of an activity for one profile on one platform.",additionalProperties:false,required:["profile","platform","delivery","reception","followerChange"],properties:{profile:{type:"string",description:"Profile the entry is for.",minLength:1,maxLength:255},platform:{type:"string",description:"Platform the entry is for.",minLength:1,maxLength:64},delivery:{type:"object",description:`Whether the activity went out for this profile and platform, from the
|
|
48
|
+
recorded outcome and the run log. Measured, never derived.
|
|
49
|
+
`,additionalProperties:false,required:["status","evidence"],properties:{status:{type:"string",description:`delivered (it went out), unconfirmed (the action was taken but its
|
|
50
|
+
outcome could not be read), failed (the last attempt failed and it
|
|
51
|
+
has not gone out), scheduled (due later), pending (due and not yet
|
|
52
|
+
run), draft (not approved, so it will not run).
|
|
53
|
+
`,enum:["delivered","unconfirmed","failed","scheduled","pending","draft"]},evidence:{type:"string",description:`What the status rests on: recorded (the outcome stored on the
|
|
54
|
+
activity), run (a run log entry), or none (nothing has happened yet).
|
|
55
|
+
`,enum:["recorded","run","none"]},deliveredAt:{type:"string",format:"date-time",description:"When it went out, as recorded.",nullable:true},scheduledFor:{type:"string",format:"date-time",description:"When it is due, for a scheduled or pending activity.",nullable:true},link:{type:"string",description:"Link to the live item on the platform.",maxLength:2048,nullable:true},computer:{type:"string",description:"Host name of the computer whose run delivered or attempted it.",maxLength:255,nullable:true},browserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},runId:{type:"string",description:"Run log identifier of the run that delivered or attempted it.",maxLength:255,nullable:true},attemptedAt:{type:"string",format:"date-time",description:"When the matched run ended.",nullable:true},durationSeconds:{type:"number",description:"How long the matched run took.",minimum:0,nullable:true},error:{type:"string",description:"The error the last failed attempt reported.",maxLength:4096,nullable:true},fix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},logPath:{type:"string",description:"Log file of the matched run, on the computer that ran it.",maxLength:2048,nullable:true}}},reception:{type:"object",description:`How the activity was received. Measured figures with the date they were
|
|
56
|
+
read, or collected false with a reason. Never zeros for missing data.
|
|
57
|
+
`,additionalProperties:false,required:["collected","measured"],properties:{collected:{type:"boolean",description:"Whether any reception figures exist for this entry."},measured:{type:"boolean",description:"Always true; reception figures are read from the platform, not computed."},reason:{type:"string",description:`Why reception is not collected: platform (nothing collects reception
|
|
58
|
+
for this platform yet), notdelivered (it has not gone out),
|
|
59
|
+
nolink (no live link to match on), notmatched (no collected figures
|
|
60
|
+
match its link yet), unavailable (the store does not hold reception
|
|
61
|
+
figures).
|
|
62
|
+
`,enum:["platform","notdelivered","nolink","notmatched","unavailable"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page the figures belong to.",maxLength:255},source:{type:"string",description:"Where the figures came from, for example a platform analytics export.",maxLength:255},asOf:{type:"string",format:"date",description:"Date the figures were read; they do not change after it.",nullable:true},metrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
63
|
+
null when the source did not report them, never zero. A
|
|
64
|
+
platform-specific figure not listed here is carried under its own key
|
|
65
|
+
only when it was reported.
|
|
66
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},comparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
67
|
+
other activities: the median of each figure and this activity's ratio
|
|
68
|
+
to it. Null when there are too few other activities to compare with.
|
|
69
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
70
|
+
null when the source did not report them, never zero. A
|
|
71
|
+
platform-specific figure not listed here is carried under its own key
|
|
72
|
+
only when it was reported.
|
|
73
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
74
|
+
null when the source did not report them, never zero. A
|
|
75
|
+
platform-specific figure not listed here is carried under its own key
|
|
76
|
+
only when it was reported.
|
|
77
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}}}},followerChange:{type:"object",description:`Derived. The subject's follower count at the reading before the activity
|
|
78
|
+
and the first reading at least the stated number of days after it.
|
|
79
|
+
Correlation only; it does not claim the activity caused the change.
|
|
80
|
+
`,additionalProperties:false,required:["collected","derived"],properties:{collected:{type:"boolean",description:"Whether follower readings exist on both sides of the activity."},derived:{type:"boolean",description:"Always true; the change is computed from two measured readings."},reason:{type:"string",description:`Why there is no change: platform (followers are not collected for
|
|
81
|
+
this subject's platform), notdelivered, noreadings (no reading on
|
|
82
|
+
one side of the activity yet).
|
|
83
|
+
`,enum:["platform","notdelivered","noreadings"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page whose followers were read.",maxLength:255},formula:{type:"string",description:"How the change is computed.",maxLength:512},windowDays:{type:"integer",description:"Days after the activity the later reading is taken from, at least.",minimum:0},before:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},after:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},change:{type:"integer",description:"after.followers minus before.followers.",nullable:true}}}}},ActivityDelivery:{type:"object",description:`Whether the activity went out for this profile and platform, from the
|
|
84
|
+
recorded outcome and the run log. Measured, never derived.
|
|
85
|
+
`,additionalProperties:false,required:["status","evidence"],properties:{status:{type:"string",description:`delivered (it went out), unconfirmed (the action was taken but its
|
|
86
|
+
outcome could not be read), failed (the last attempt failed and it
|
|
87
|
+
has not gone out), scheduled (due later), pending (due and not yet
|
|
88
|
+
run), draft (not approved, so it will not run).
|
|
89
|
+
`,enum:["delivered","unconfirmed","failed","scheduled","pending","draft"]},evidence:{type:"string",description:`What the status rests on: recorded (the outcome stored on the
|
|
90
|
+
activity), run (a run log entry), or none (nothing has happened yet).
|
|
91
|
+
`,enum:["recorded","run","none"]},deliveredAt:{type:"string",format:"date-time",description:"When it went out, as recorded.",nullable:true},scheduledFor:{type:"string",format:"date-time",description:"When it is due, for a scheduled or pending activity.",nullable:true},link:{type:"string",description:"Link to the live item on the platform.",maxLength:2048,nullable:true},computer:{type:"string",description:"Host name of the computer whose run delivered or attempted it.",maxLength:255,nullable:true},browserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},runId:{type:"string",description:"Run log identifier of the run that delivered or attempted it.",maxLength:255,nullable:true},attemptedAt:{type:"string",format:"date-time",description:"When the matched run ended.",nullable:true},durationSeconds:{type:"number",description:"How long the matched run took.",minimum:0,nullable:true},error:{type:"string",description:"The error the last failed attempt reported.",maxLength:4096,nullable:true},fix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},logPath:{type:"string",description:"Log file of the matched run, on the computer that ran it.",maxLength:2048,nullable:true}}},ActivityBrowserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},ActivityFix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},ActivityMetrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
92
|
+
null when the source did not report them, never zero. A
|
|
93
|
+
platform-specific figure not listed here is carried under its own key
|
|
94
|
+
only when it was reported.
|
|
95
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ActivityComparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
96
|
+
other activities: the median of each figure and this activity's ratio
|
|
97
|
+
to it. Null when there are too few other activities to compare with.
|
|
98
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
99
|
+
null when the source did not report them, never zero. A
|
|
100
|
+
platform-specific figure not listed here is carried under its own key
|
|
101
|
+
only when it was reported.
|
|
102
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
103
|
+
null when the source did not report them, never zero. A
|
|
104
|
+
platform-specific figure not listed here is carried under its own key
|
|
105
|
+
only when it was reported.
|
|
106
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}},ActivityReception:{type:"object",description:`How the activity was received. Measured figures with the date they were
|
|
107
|
+
read, or collected false with a reason. Never zeros for missing data.
|
|
108
|
+
`,additionalProperties:false,required:["collected","measured"],properties:{collected:{type:"boolean",description:"Whether any reception figures exist for this entry."},measured:{type:"boolean",description:"Always true; reception figures are read from the platform, not computed."},reason:{type:"string",description:`Why reception is not collected: platform (nothing collects reception
|
|
109
|
+
for this platform yet), notdelivered (it has not gone out),
|
|
110
|
+
nolink (no live link to match on), notmatched (no collected figures
|
|
111
|
+
match its link yet), unavailable (the store does not hold reception
|
|
112
|
+
figures).
|
|
113
|
+
`,enum:["platform","notdelivered","nolink","notmatched","unavailable"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page the figures belong to.",maxLength:255},source:{type:"string",description:"Where the figures came from, for example a platform analytics export.",maxLength:255},asOf:{type:"string",format:"date",description:"Date the figures were read; they do not change after it.",nullable:true},metrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
114
|
+
null when the source did not report them, never zero. A
|
|
115
|
+
platform-specific figure not listed here is carried under its own key
|
|
116
|
+
only when it was reported.
|
|
117
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},comparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
118
|
+
other activities: the median of each figure and this activity's ratio
|
|
119
|
+
to it. Null when there are too few other activities to compare with.
|
|
120
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
121
|
+
null when the source did not report them, never zero. A
|
|
122
|
+
platform-specific figure not listed here is carried under its own key
|
|
123
|
+
only when it was reported.
|
|
124
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
125
|
+
null when the source did not report them, never zero. A
|
|
126
|
+
platform-specific figure not listed here is carried under its own key
|
|
127
|
+
only when it was reported.
|
|
128
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}}}},ActivityFollowerChange:{type:"object",description:`Derived. The subject's follower count at the reading before the activity
|
|
129
|
+
and the first reading at least the stated number of days after it.
|
|
130
|
+
Correlation only; it does not claim the activity caused the change.
|
|
131
|
+
`,additionalProperties:false,required:["collected","derived"],properties:{collected:{type:"boolean",description:"Whether follower readings exist on both sides of the activity."},derived:{type:"boolean",description:"Always true; the change is computed from two measured readings."},reason:{type:"string",description:`Why there is no change: platform (followers are not collected for
|
|
132
|
+
this subject's platform), notdelivered, noreadings (no reading on
|
|
133
|
+
one side of the activity yet).
|
|
134
|
+
`,enum:["platform","notdelivered","noreadings"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page whose followers were read.",maxLength:255},formula:{type:"string",description:"How the change is computed.",maxLength:512},windowDays:{type:"integer",description:"Days after the activity the later reading is taken from, at least.",minimum:0},before:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},after:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},change:{type:"integer",description:"after.followers minus before.followers.",nullable:true}}},ActivityFollowerReading:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}}}}},t=e;module.exports=t;
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"ActivityResult",description:`OpenAPI schema for the result of one activity: delivery per profile and
|
|
2
|
+
platform, reception where it is collected, and derived follower context.
|
|
3
|
+
Contract only; it declares no endpoints. Clients that assemble a result
|
|
4
|
+
locally (a command line, a desktop panel) and a server that later serves
|
|
5
|
+
it share these types.
|
|
6
|
+
`,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:{schemas:{ActivityResult:{$schema:"http://json-schema.org/draft-07/schema#",title:"Activity Result Schema",description:`The result of one activity: whether it went out on each platform and for
|
|
7
|
+
each profile it was addressed to, how it was received where reception is
|
|
8
|
+
collected, and the follower change around it. One entry per profile and
|
|
9
|
+
platform. Every figure says whether it was measured or derived, and
|
|
10
|
+
anything not collected says so with a reason instead of a zero.
|
|
11
|
+
`,type:"object",additionalProperties:false,required:["activityId","kind","platform","generatedAt","entries"],properties:{activityId:{type:"string",description:"Identifier of the activity the result describes (for a content piece, its row number as a string).",minLength:1,maxLength:255,"x-order":1},kind:{type:"string",description:"What the activity does, such as post, repost, comment, like, connect or invite.",minLength:1,maxLength:64,"x-order":2},platform:{type:"string",description:"Platform the activity targets (for example linkedin, x, bluesky).",minLength:1,maxLength:64,"x-order":3},title:{type:"string",description:"Short human-readable preview of the activity.",maxLength:512,"x-order":4},state:{type:"string",description:"The activity's queue state when the result was read (for example done, partial, pending, scheduled, draft).",maxLength:64,"x-order":5},generatedAt:{description:"When this result was assembled.","x-order":6,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},entries:{type:"array",description:"One entry per profile and platform the activity is addressed to.",items:{type:"object",description:"The result of an activity for one profile on one platform.",additionalProperties:false,required:["profile","platform","delivery","reception","followerChange"],properties:{profile:{type:"string",description:"Profile the entry is for.",minLength:1,maxLength:255},platform:{type:"string",description:"Platform the entry is for.",minLength:1,maxLength:64},delivery:{type:"object",description:`Whether the activity went out for this profile and platform, from the
|
|
12
|
+
recorded outcome and the run log. Measured, never derived.
|
|
13
|
+
`,additionalProperties:false,required:["status","evidence"],properties:{status:{type:"string",description:`delivered (it went out), unconfirmed (the action was taken but its
|
|
14
|
+
outcome could not be read), failed (the last attempt failed and it
|
|
15
|
+
has not gone out), scheduled (due later), pending (due and not yet
|
|
16
|
+
run), draft (not approved, so it will not run).
|
|
17
|
+
`,enum:["delivered","unconfirmed","failed","scheduled","pending","draft"]},evidence:{type:"string",description:`What the status rests on: recorded (the outcome stored on the
|
|
18
|
+
activity), run (a run log entry), or none (nothing has happened yet).
|
|
19
|
+
`,enum:["recorded","run","none"]},deliveredAt:{type:"string",format:"date-time",description:"When it went out, as recorded.",nullable:true},scheduledFor:{type:"string",format:"date-time",description:"When it is due, for a scheduled or pending activity.",nullable:true},link:{type:"string",description:"Link to the live item on the platform.",maxLength:2048,nullable:true},computer:{type:"string",description:"Host name of the computer whose run delivered or attempted it.",maxLength:255,nullable:true},browserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},runId:{type:"string",description:"Run log identifier of the run that delivered or attempted it.",maxLength:255,nullable:true},attemptedAt:{type:"string",format:"date-time",description:"When the matched run ended.",nullable:true},durationSeconds:{type:"number",description:"How long the matched run took.",minimum:0,nullable:true},error:{type:"string",description:"The error the last failed attempt reported.",maxLength:4096,nullable:true},fix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},logPath:{type:"string",description:"Log file of the matched run, on the computer that ran it.",maxLength:2048,nullable:true}}},reception:{type:"object",description:`How the activity was received. Measured figures with the date they were
|
|
20
|
+
read, or collected false with a reason. Never zeros for missing data.
|
|
21
|
+
`,additionalProperties:false,required:["collected","measured"],properties:{collected:{type:"boolean",description:"Whether any reception figures exist for this entry."},measured:{type:"boolean",description:"Always true; reception figures are read from the platform, not computed."},reason:{type:"string",description:`Why reception is not collected: platform (nothing collects reception
|
|
22
|
+
for this platform yet), notdelivered (it has not gone out),
|
|
23
|
+
nolink (no live link to match on), notmatched (no collected figures
|
|
24
|
+
match its link yet), unavailable (the store does not hold reception
|
|
25
|
+
figures).
|
|
26
|
+
`,enum:["platform","notdelivered","nolink","notmatched","unavailable"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page the figures belong to.",maxLength:255},source:{type:"string",description:"Where the figures came from, for example a platform analytics export.",maxLength:255},asOf:{type:"string",format:"date",description:"Date the figures were read; they do not change after it.",nullable:true},metrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
27
|
+
null when the source did not report them, never zero. A
|
|
28
|
+
platform-specific figure not listed here is carried under its own key
|
|
29
|
+
only when it was reported.
|
|
30
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},comparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
31
|
+
other activities: the median of each figure and this activity's ratio
|
|
32
|
+
to it. Null when there are too few other activities to compare with.
|
|
33
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
34
|
+
null when the source did not report them, never zero. A
|
|
35
|
+
platform-specific figure not listed here is carried under its own key
|
|
36
|
+
only when it was reported.
|
|
37
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
38
|
+
null when the source did not report them, never zero. A
|
|
39
|
+
platform-specific figure not listed here is carried under its own key
|
|
40
|
+
only when it was reported.
|
|
41
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}}}},followerChange:{type:"object",description:`Derived. The subject's follower count at the reading before the activity
|
|
42
|
+
and the first reading at least the stated number of days after it.
|
|
43
|
+
Correlation only; it does not claim the activity caused the change.
|
|
44
|
+
`,additionalProperties:false,required:["collected","derived"],properties:{collected:{type:"boolean",description:"Whether follower readings exist on both sides of the activity."},derived:{type:"boolean",description:"Always true; the change is computed from two measured readings."},reason:{type:"string",description:`Why there is no change: platform (followers are not collected for
|
|
45
|
+
this subject's platform), notdelivered, noreadings (no reading on
|
|
46
|
+
one side of the activity yet).
|
|
47
|
+
`,enum:["platform","notdelivered","noreadings"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page whose followers were read.",maxLength:255},formula:{type:"string",description:"How the change is computed.",maxLength:512},windowDays:{type:"integer",description:"Days after the activity the later reading is taken from, at least.",minimum:0},before:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},after:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},change:{type:"integer",description:"after.followers minus before.followers.",nullable:true}}}}},"x-order":7}}},ActivityResultEntry:{type:"object",description:"The result of an activity for one profile on one platform.",additionalProperties:false,required:["profile","platform","delivery","reception","followerChange"],properties:{profile:{type:"string",description:"Profile the entry is for.",minLength:1,maxLength:255},platform:{type:"string",description:"Platform the entry is for.",minLength:1,maxLength:64},delivery:{type:"object",description:`Whether the activity went out for this profile and platform, from the
|
|
48
|
+
recorded outcome and the run log. Measured, never derived.
|
|
49
|
+
`,additionalProperties:false,required:["status","evidence"],properties:{status:{type:"string",description:`delivered (it went out), unconfirmed (the action was taken but its
|
|
50
|
+
outcome could not be read), failed (the last attempt failed and it
|
|
51
|
+
has not gone out), scheduled (due later), pending (due and not yet
|
|
52
|
+
run), draft (not approved, so it will not run).
|
|
53
|
+
`,enum:["delivered","unconfirmed","failed","scheduled","pending","draft"]},evidence:{type:"string",description:`What the status rests on: recorded (the outcome stored on the
|
|
54
|
+
activity), run (a run log entry), or none (nothing has happened yet).
|
|
55
|
+
`,enum:["recorded","run","none"]},deliveredAt:{type:"string",format:"date-time",description:"When it went out, as recorded.",nullable:true},scheduledFor:{type:"string",format:"date-time",description:"When it is due, for a scheduled or pending activity.",nullable:true},link:{type:"string",description:"Link to the live item on the platform.",maxLength:2048,nullable:true},computer:{type:"string",description:"Host name of the computer whose run delivered or attempted it.",maxLength:255,nullable:true},browserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},runId:{type:"string",description:"Run log identifier of the run that delivered or attempted it.",maxLength:255,nullable:true},attemptedAt:{type:"string",format:"date-time",description:"When the matched run ended.",nullable:true},durationSeconds:{type:"number",description:"How long the matched run took.",minimum:0,nullable:true},error:{type:"string",description:"The error the last failed attempt reported.",maxLength:4096,nullable:true},fix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},logPath:{type:"string",description:"Log file of the matched run, on the computer that ran it.",maxLength:2048,nullable:true}}},reception:{type:"object",description:`How the activity was received. Measured figures with the date they were
|
|
56
|
+
read, or collected false with a reason. Never zeros for missing data.
|
|
57
|
+
`,additionalProperties:false,required:["collected","measured"],properties:{collected:{type:"boolean",description:"Whether any reception figures exist for this entry."},measured:{type:"boolean",description:"Always true; reception figures are read from the platform, not computed."},reason:{type:"string",description:`Why reception is not collected: platform (nothing collects reception
|
|
58
|
+
for this platform yet), notdelivered (it has not gone out),
|
|
59
|
+
nolink (no live link to match on), notmatched (no collected figures
|
|
60
|
+
match its link yet), unavailable (the store does not hold reception
|
|
61
|
+
figures).
|
|
62
|
+
`,enum:["platform","notdelivered","nolink","notmatched","unavailable"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page the figures belong to.",maxLength:255},source:{type:"string",description:"Where the figures came from, for example a platform analytics export.",maxLength:255},asOf:{type:"string",format:"date",description:"Date the figures were read; they do not change after it.",nullable:true},metrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
63
|
+
null when the source did not report them, never zero. A
|
|
64
|
+
platform-specific figure not listed here is carried under its own key
|
|
65
|
+
only when it was reported.
|
|
66
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},comparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
67
|
+
other activities: the median of each figure and this activity's ratio
|
|
68
|
+
to it. Null when there are too few other activities to compare with.
|
|
69
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
70
|
+
null when the source did not report them, never zero. A
|
|
71
|
+
platform-specific figure not listed here is carried under its own key
|
|
72
|
+
only when it was reported.
|
|
73
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
74
|
+
null when the source did not report them, never zero. A
|
|
75
|
+
platform-specific figure not listed here is carried under its own key
|
|
76
|
+
only when it was reported.
|
|
77
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}}}},followerChange:{type:"object",description:`Derived. The subject's follower count at the reading before the activity
|
|
78
|
+
and the first reading at least the stated number of days after it.
|
|
79
|
+
Correlation only; it does not claim the activity caused the change.
|
|
80
|
+
`,additionalProperties:false,required:["collected","derived"],properties:{collected:{type:"boolean",description:"Whether follower readings exist on both sides of the activity."},derived:{type:"boolean",description:"Always true; the change is computed from two measured readings."},reason:{type:"string",description:`Why there is no change: platform (followers are not collected for
|
|
81
|
+
this subject's platform), notdelivered, noreadings (no reading on
|
|
82
|
+
one side of the activity yet).
|
|
83
|
+
`,enum:["platform","notdelivered","noreadings"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page whose followers were read.",maxLength:255},formula:{type:"string",description:"How the change is computed.",maxLength:512},windowDays:{type:"integer",description:"Days after the activity the later reading is taken from, at least.",minimum:0},before:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},after:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},change:{type:"integer",description:"after.followers minus before.followers.",nullable:true}}}}},ActivityDelivery:{type:"object",description:`Whether the activity went out for this profile and platform, from the
|
|
84
|
+
recorded outcome and the run log. Measured, never derived.
|
|
85
|
+
`,additionalProperties:false,required:["status","evidence"],properties:{status:{type:"string",description:`delivered (it went out), unconfirmed (the action was taken but its
|
|
86
|
+
outcome could not be read), failed (the last attempt failed and it
|
|
87
|
+
has not gone out), scheduled (due later), pending (due and not yet
|
|
88
|
+
run), draft (not approved, so it will not run).
|
|
89
|
+
`,enum:["delivered","unconfirmed","failed","scheduled","pending","draft"]},evidence:{type:"string",description:`What the status rests on: recorded (the outcome stored on the
|
|
90
|
+
activity), run (a run log entry), or none (nothing has happened yet).
|
|
91
|
+
`,enum:["recorded","run","none"]},deliveredAt:{type:"string",format:"date-time",description:"When it went out, as recorded.",nullable:true},scheduledFor:{type:"string",format:"date-time",description:"When it is due, for a scheduled or pending activity.",nullable:true},link:{type:"string",description:"Link to the live item on the platform.",maxLength:2048,nullable:true},computer:{type:"string",description:"Host name of the computer whose run delivered or attempted it.",maxLength:255,nullable:true},browserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},runId:{type:"string",description:"Run log identifier of the run that delivered or attempted it.",maxLength:255,nullable:true},attemptedAt:{type:"string",format:"date-time",description:"When the matched run ended.",nullable:true},durationSeconds:{type:"number",description:"How long the matched run took.",minimum:0,nullable:true},error:{type:"string",description:"The error the last failed attempt reported.",maxLength:4096,nullable:true},fix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},logPath:{type:"string",description:"Log file of the matched run, on the computer that ran it.",maxLength:2048,nullable:true}}},ActivityBrowserProfile:{type:"object",description:"The browser profile a run used on its computer, when one was mapped. Null when unknown.",nullable:true,additionalProperties:false,required:["directory"],properties:{directory:{type:"string",description:"Browser profile directory name.",minLength:1,maxLength:255},displayName:{type:"string",description:"Name the browser showed for the profile.",maxLength:255}}},ActivityFix:{type:"object",description:"What to do about a failed delivery. Null when nothing failed.",nullable:true,additionalProperties:false,required:["summary"],properties:{summary:{type:"string",description:"One plain sentence saying what to do next.",minLength:1,maxLength:1024},command:{type:"string",description:"A command line that performs the fix, when there is one.",maxLength:1024,nullable:true}}},ActivityMetrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
92
|
+
null when the source did not report them, never zero. A
|
|
93
|
+
platform-specific figure not listed here is carried under its own key
|
|
94
|
+
only when it was reported.
|
|
95
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ActivityComparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
96
|
+
other activities: the median of each figure and this activity's ratio
|
|
97
|
+
to it. Null when there are too few other activities to compare with.
|
|
98
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
99
|
+
null when the source did not report them, never zero. A
|
|
100
|
+
platform-specific figure not listed here is carried under its own key
|
|
101
|
+
only when it was reported.
|
|
102
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
103
|
+
null when the source did not report them, never zero. A
|
|
104
|
+
platform-specific figure not listed here is carried under its own key
|
|
105
|
+
only when it was reported.
|
|
106
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}},ActivityReception:{type:"object",description:`How the activity was received. Measured figures with the date they were
|
|
107
|
+
read, or collected false with a reason. Never zeros for missing data.
|
|
108
|
+
`,additionalProperties:false,required:["collected","measured"],properties:{collected:{type:"boolean",description:"Whether any reception figures exist for this entry."},measured:{type:"boolean",description:"Always true; reception figures are read from the platform, not computed."},reason:{type:"string",description:`Why reception is not collected: platform (nothing collects reception
|
|
109
|
+
for this platform yet), notdelivered (it has not gone out),
|
|
110
|
+
nolink (no live link to match on), notmatched (no collected figures
|
|
111
|
+
match its link yet), unavailable (the store does not hold reception
|
|
112
|
+
figures).
|
|
113
|
+
`,enum:["platform","notdelivered","nolink","notmatched","unavailable"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page the figures belong to.",maxLength:255},source:{type:"string",description:"Where the figures came from, for example a platform analytics export.",maxLength:255},asOf:{type:"string",format:"date",description:"Date the figures were read; they do not change after it.",nullable:true},metrics:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
114
|
+
null when the source did not report them, never zero. A
|
|
115
|
+
platform-specific figure not listed here is carried under its own key
|
|
116
|
+
only when it was reported.
|
|
117
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},comparison:{type:"object",description:`Derived. How this activity's figures compare with the same subject's
|
|
118
|
+
other activities: the median of each figure and this activity's ratio
|
|
119
|
+
to it. Null when there are too few other activities to compare with.
|
|
120
|
+
`,nullable:true,additionalProperties:false,required:["basis","sampleSize","median","ratio"],properties:{basis:{type:"string",description:"How the typical activity is computed.",enum:["median"]},sampleSize:{type:"integer",description:"How many other activities the median is taken over.",minimum:0},median:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
121
|
+
null when the source did not report them, never zero. A
|
|
122
|
+
platform-specific figure not listed here is carried under its own key
|
|
123
|
+
only when it was reported.
|
|
124
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}},ratio:{type:"object",description:`Per-activity engagement figures. The known keys are declared and are
|
|
125
|
+
null when the source did not report them, never zero. A
|
|
126
|
+
platform-specific figure not listed here is carried under its own key
|
|
127
|
+
only when it was reported.
|
|
128
|
+
`,additionalProperties:{type:"number"},properties:{impressions:{type:"number",nullable:true,description:"Times the activity was shown."},views:{type:"number",nullable:true,description:"Views, for media activities."},offsiteViews:{type:"number",nullable:true,description:"Views outside the platform."},clicks:{type:"number",nullable:true,description:"Clicks on the activity."},clickThroughRate:{type:"number",nullable:true,description:"Clicks divided by impressions, as a fraction."},likes:{type:"number",nullable:true,description:"Likes or reactions."},comments:{type:"number",nullable:true,description:"Comments."},reposts:{type:"number",nullable:true,description:"Reposts or shares."},follows:{type:"number",nullable:true,description:"Follows attributed to the activity."},engagementRate:{type:"number",nullable:true,description:"Engagements divided by impressions, as a fraction."}}}}}}},ActivityFollowerChange:{type:"object",description:`Derived. The subject's follower count at the reading before the activity
|
|
129
|
+
and the first reading at least the stated number of days after it.
|
|
130
|
+
Correlation only; it does not claim the activity caused the change.
|
|
131
|
+
`,additionalProperties:false,required:["collected","derived"],properties:{collected:{type:"boolean",description:"Whether follower readings exist on both sides of the activity."},derived:{type:"boolean",description:"Always true; the change is computed from two measured readings."},reason:{type:"string",description:`Why there is no change: platform (followers are not collected for
|
|
132
|
+
this subject's platform), notdelivered, noreadings (no reading on
|
|
133
|
+
one side of the activity yet).
|
|
134
|
+
`,enum:["platform","notdelivered","noreadings"]},message:{type:"string",description:"One plain sentence for a person explaining the reason.",maxLength:1024},subject:{type:"string",description:"Account or page whose followers were read.",maxLength:255},formula:{type:"string",description:"How the change is computed.",maxLength:512},windowDays:{type:"integer",description:"Days after the activity the later reading is taken from, at least.",minimum:0},before:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},after:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}},change:{type:"integer",description:"after.followers minus before.followers.",nullable:true}}},ActivityFollowerReading:{type:"object",description:"One measured follower reading. Null when there is none.",nullable:true,additionalProperties:false,required:["date","followers"],properties:{date:{type:"string",format:"date",description:"Date of the reading."},followers:{type:"integer",description:"Followers at that reading.",minimum:0}}}}}},t=e;export{t as default};
|
|
@@ -303,7 +303,7 @@ export interface components {
|
|
|
303
303
|
isOauth: boolean;
|
|
304
304
|
/** @description Name of the token. */
|
|
305
305
|
name: string;
|
|
306
|
-
/** @description Token purpose. Tokens are minted with this purpose on generate,
|
|
306
|
+
/** @description Token purpose. Tokens are minted with this purpose on generate. On list, only tokens whose purpose is exactly this value (case-sensitive, not a substring match) are returned; omit it to list every purpose. */
|
|
307
307
|
purpose: string;
|
|
308
308
|
/** @description Display name of the native client asking to sign in. Shown on the consent page and used as the name and purpose of the minted token. */
|
|
309
309
|
nativeClientName: string;
|
|
@@ -327,7 +327,7 @@ export interface operations {
|
|
|
327
327
|
query?: {
|
|
328
328
|
/** @description Whether to retrieve OAuth-backed sessions instead of API tokens. */
|
|
329
329
|
isOauth?: boolean;
|
|
330
|
-
/** @description Token purpose. Tokens are minted with this purpose on generate,
|
|
330
|
+
/** @description Token purpose. Tokens are minted with this purpose on generate. On list, only tokens whose purpose is exactly this value (case-sensitive, not a substring match) are returned; omit it to list every purpose. */
|
|
331
331
|
purpose?: string;
|
|
332
332
|
/** @description Get responses by page */
|
|
333
333
|
page?: number;
|
|
@@ -425,7 +425,7 @@ export interface operations {
|
|
|
425
425
|
query: {
|
|
426
426
|
/** @description Name of the token. */
|
|
427
427
|
name: string;
|
|
428
|
-
/** @description Token purpose. Tokens are minted with this purpose on generate,
|
|
428
|
+
/** @description Token purpose. Tokens are minted with this purpose on generate. On list, only tokens whose purpose is exactly this value (case-sensitive, not a substring match) are returned; omit it to list every purpose. */
|
|
429
429
|
purpose?: string;
|
|
430
430
|
};
|
|
431
431
|
header?: never;
|