-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathinsights.go
More file actions
500 lines (432 loc) · 16.5 KB
/
insights.go
File metadata and controls
500 lines (432 loc) · 16.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
package threads
import (
"context"
"encoding/json"
"fmt"
"net/url"
"strings"
"time"
)
// PostInsightMetric represents available post insight metrics
type PostInsightMetric string
const (
// PostInsightViews represents the number of times a post was viewed.
// Note: This metric is noted as "in development" in the API documentation.
PostInsightViews PostInsightMetric = "views"
// PostInsightLikes represents the number of likes a post received
PostInsightLikes PostInsightMetric = "likes"
// PostInsightReplies represents the number of replies a post received
PostInsightReplies PostInsightMetric = "replies"
// PostInsightReposts represents the number of times a post was reposted
PostInsightReposts PostInsightMetric = "reposts"
// PostInsightQuotes represents the number of times a post was quoted
PostInsightQuotes PostInsightMetric = "quotes"
// PostInsightShares represents the number of times a post was shared.
// Note: This metric is noted as "in development" in the API documentation.
PostInsightShares PostInsightMetric = "shares"
)
// AccountInsightMetric represents available account insight metrics
type AccountInsightMetric string
const (
// AccountInsightViews represents the total views across all account posts.
// Note: This metric is noted as "in development" in the API documentation.
AccountInsightViews AccountInsightMetric = "views"
// AccountInsightLikes represents the total likes across all account posts
AccountInsightLikes AccountInsightMetric = "likes"
// AccountInsightReplies represents the total replies across all account posts
AccountInsightReplies AccountInsightMetric = "replies"
// AccountInsightReposts represents the total reposts across all account posts
AccountInsightReposts AccountInsightMetric = "reposts"
// AccountInsightQuotes represents the total quotes across all account posts
AccountInsightQuotes AccountInsightMetric = "quotes"
// AccountInsightClicks represents the total clicks across all account posts
AccountInsightClicks AccountInsightMetric = "clicks"
// AccountInsightFollowersCount represents the account's follower count
AccountInsightFollowersCount AccountInsightMetric = "followers_count"
// AccountInsightFollowerDemographics represents the demographic breakdown of followers
AccountInsightFollowerDemographics AccountInsightMetric = "follower_demographics"
)
// InsightPeriod represents the time period for insights
type InsightPeriod string
const (
// InsightPeriodDay represents daily insights data
InsightPeriodDay InsightPeriod = "day"
// InsightPeriodLifetime represents lifetime/total insights data
InsightPeriodLifetime InsightPeriod = "lifetime"
)
// Constants for API limitations
const (
// MinInsightTimestamp is the earliest Unix timestamp that can be used (1712991600)
MinInsightTimestamp int64 = 1712991600
)
// FollowerDemographicsBreakdown represents breakdown options for follower demographics
type FollowerDemographicsBreakdown string
const (
// BreakdownCountry represents follower demographics breakdown by country
BreakdownCountry FollowerDemographicsBreakdown = "country"
// BreakdownCity represents follower demographics breakdown by city
BreakdownCity FollowerDemographicsBreakdown = "city"
// BreakdownAge represents follower demographics breakdown by age group
BreakdownAge FollowerDemographicsBreakdown = "age"
// BreakdownGender represents follower demographics breakdown by gender
BreakdownGender FollowerDemographicsBreakdown = "gender"
)
// PostInsightsOptions represents options for post insights requests
type PostInsightsOptions struct {
Metrics []PostInsightMetric `json:"metrics,omitempty"`
Period InsightPeriod `json:"period,omitempty"`
Since *time.Time `json:"since,omitempty"`
Until *time.Time `json:"until,omitempty"`
}
// AccountInsightsOptions represents options for account insights requests
type AccountInsightsOptions struct {
Metrics []AccountInsightMetric `json:"metrics,omitempty"`
Period InsightPeriod `json:"period,omitempty"`
Since *time.Time `json:"since,omitempty"`
Until *time.Time `json:"until,omitempty"`
Breakdown string `json:"breakdown,omitempty"` // For follower_demographics: country, city, age, or gender
}
// GetPostInsights retrieves insights for a specific post.
// For insights API documentation, see: https://developers.facebook.com/docs/threads/insights
func (c *Client) GetPostInsights(ctx context.Context, postID PostID, metrics []string) (*InsightsResponse, error) {
if !postID.Valid() {
return nil, NewValidationError(400, ErrEmptyPostID, "postID cannot be empty", "postID")
}
// Validate metrics
validMetrics := make([]string, 0, len(metrics))
for _, metric := range metrics {
if err := c.validatePostInsightMetric(metric); err != nil {
return nil, err
}
validMetrics = append(validMetrics, metric)
}
// If no metrics specified, use default metrics
if len(validMetrics) == 0 {
validMetrics = []string{
string(PostInsightViews),
string(PostInsightLikes),
string(PostInsightReplies),
string(PostInsightReposts),
}
}
params := url.Values{}
params.Set("metric", strings.Join(validMetrics, ","))
path := fmt.Sprintf("/%s/insights", postID.String())
response, err := c.httpClient.GET(path, params, c.getAccessTokenSafe())
if err != nil {
return nil, fmt.Errorf("failed to get post insights: %w", err)
}
var insightsResponse InsightsResponse
if err := json.Unmarshal(response.Body, &insightsResponse); err != nil {
return nil, fmt.Errorf("failed to decode insights response: %w", err)
}
return &insightsResponse, nil
}
// GetPostInsightsWithOptions retrieves insights for a specific post with advanced options
func (c *Client) GetPostInsightsWithOptions(ctx context.Context, postID PostID, opts *PostInsightsOptions) (*InsightsResponse, error) {
if !postID.Valid() {
return nil, NewValidationError(400, ErrEmptyPostID, "postID cannot be empty", "postID")
}
if opts == nil {
opts = &PostInsightsOptions{}
}
// Validate and prepare metrics
var validMetrics []string
if len(opts.Metrics) > 0 {
for _, metric := range opts.Metrics {
if err := c.validatePostInsightMetric(string(metric)); err != nil {
return nil, err
}
validMetrics = append(validMetrics, string(metric))
}
} else {
// Use default metrics if none specified
validMetrics = []string{
string(PostInsightViews),
string(PostInsightLikes),
string(PostInsightReplies),
string(PostInsightReposts),
}
}
params := url.Values{}
params.Set("metric", strings.Join(validMetrics, ","))
// Add period if specified
if opts.Period != "" {
if err := c.validateInsightPeriod(string(opts.Period)); err != nil {
return nil, err
}
params.Set("period", string(opts.Period))
}
// Add date range if specified
if opts.Since != nil {
params.Set("since", fmt.Sprintf("%d", opts.Since.Unix()))
}
if opts.Until != nil {
params.Set("until", fmt.Sprintf("%d", opts.Until.Unix()))
}
// Validate date range
if opts.Since != nil && opts.Until != nil {
if opts.Since.After(*opts.Until) {
return nil, NewValidationError(400, "Invalid date range", "since date cannot be after until date", "since")
}
}
path := fmt.Sprintf("/%s/insights", postID.String())
response, err := c.httpClient.GET(path, params, c.getAccessTokenSafe())
if err != nil {
return nil, fmt.Errorf("failed to get post insights: %w", err)
}
var insightsResponse InsightsResponse
if err := json.Unmarshal(response.Body, &insightsResponse); err != nil {
return nil, fmt.Errorf("failed to decode insights response: %w", err)
}
return &insightsResponse, nil
}
// GetAccountInsights retrieves insights for a user account
func (c *Client) GetAccountInsights(ctx context.Context, userID UserID, metrics []string, period string) (*InsightsResponse, error) {
if !userID.Valid() {
return nil, NewValidationError(400, ErrEmptyUserID, "userID cannot be empty", "userID")
}
// Validate metrics
validMetrics := make([]string, 0, len(metrics))
for _, metric := range metrics {
if err := c.validateAccountInsightMetric(metric); err != nil {
return nil, err
}
validMetrics = append(validMetrics, metric)
}
// If no metrics specified, use default metrics
if len(validMetrics) == 0 {
validMetrics = []string{
string(AccountInsightViews),
string(AccountInsightLikes),
string(AccountInsightReplies),
string(AccountInsightReposts),
}
}
params := url.Values{}
params.Set("metric", strings.Join(validMetrics, ","))
// Validate and set period
if period != "" {
if err := c.validateInsightPeriod(period); err != nil {
return nil, err
}
params.Set("period", period)
} else {
// Default to lifetime if no period specified
params.Set("period", string(InsightPeriodLifetime))
}
path := fmt.Sprintf("/%s/threads_insights", userID.String())
response, err := c.httpClient.GET(path, params, c.getAccessTokenSafe())
if err != nil {
return nil, fmt.Errorf("failed to get account insights: %w", err)
}
var insightsResponse InsightsResponse
if err := json.Unmarshal(response.Body, &insightsResponse); err != nil {
return nil, fmt.Errorf("failed to decode insights response: %w", err)
}
return &insightsResponse, nil
}
// GetAccountInsightsWithOptions retrieves insights for a user account with advanced options
func (c *Client) GetAccountInsightsWithOptions(ctx context.Context, userID UserID, opts *AccountInsightsOptions) (*InsightsResponse, error) {
if !userID.Valid() {
return nil, NewValidationError(400, ErrEmptyUserID, "userID cannot be empty", "userID")
}
if opts == nil {
opts = &AccountInsightsOptions{}
}
// Validate and prepare metrics
var validMetrics []string
if len(opts.Metrics) > 0 {
for _, metric := range opts.Metrics {
if err := c.validateAccountInsightMetric(string(metric)); err != nil {
return nil, err
}
validMetrics = append(validMetrics, string(metric))
}
} else {
// Use default metrics if none specified
validMetrics = []string{
string(AccountInsightViews),
string(AccountInsightLikes),
string(AccountInsightReplies),
string(AccountInsightReposts),
}
}
params := url.Values{}
params.Set("metric", strings.Join(validMetrics, ","))
// Add period if specified, otherwise default to lifetime
if opts.Period != "" {
if err := c.validateInsightPeriod(string(opts.Period)); err != nil {
return nil, err
}
params.Set("period", string(opts.Period))
} else {
params.Set("period", string(InsightPeriodLifetime))
}
// Check for metrics that don't support since/until parameters
hasFollowerDemographics := false
hasFollowersCount := false
for _, metric := range validMetrics {
if metric == string(AccountInsightFollowerDemographics) {
hasFollowerDemographics = true
}
if metric == string(AccountInsightFollowersCount) {
hasFollowersCount = true
}
}
if hasFollowerDemographics {
// follower_demographics doesn't support since/until parameters
if opts.Since != nil || opts.Until != nil {
return nil, NewValidationError(400, "Invalid parameters",
"follower_demographics metric does not support since and until parameters", "metric")
}
// Validate breakdown parameter
if opts.Breakdown != "" {
if err := c.validateFollowerDemographicsBreakdown(opts.Breakdown); err != nil {
return nil, err
}
params.Set("breakdown", opts.Breakdown)
}
}
if hasFollowersCount {
// followers_count doesn't support since/until parameters
if opts.Since != nil || opts.Until != nil {
return nil, NewValidationError(400, "Invalid parameters",
"followers_count metric does not support since and until parameters", "metric")
}
}
if !hasFollowerDemographics && !hasFollowersCount {
// Validate minimum timestamp for other metrics
if opts.Since != nil && opts.Since.Unix() < MinInsightTimestamp {
return nil, NewValidationError(400, "Invalid since timestamp",
fmt.Sprintf("since timestamp must be >= %d", MinInsightTimestamp), "since")
}
if opts.Until != nil && opts.Until.Unix() < MinInsightTimestamp {
return nil, NewValidationError(400, "Invalid until timestamp",
fmt.Sprintf("until timestamp must be >= %d", MinInsightTimestamp), "until")
}
// Add date range if specified
if opts.Since != nil {
params.Set("since", fmt.Sprintf("%d", opts.Since.Unix()))
}
if opts.Until != nil {
params.Set("until", fmt.Sprintf("%d", opts.Until.Unix()))
}
}
// Validate date range
if opts.Since != nil && opts.Until != nil {
if opts.Since.After(*opts.Until) {
return nil, NewValidationError(400, "Invalid date range", "since date cannot be after until date", "since")
}
}
path := fmt.Sprintf("/%s/threads_insights", userID.String())
response, err := c.httpClient.GET(path, params, c.getAccessTokenSafe())
if err != nil {
return nil, fmt.Errorf("failed to get account insights: %w", err)
}
var insightsResponse InsightsResponse
if err := json.Unmarshal(response.Body, &insightsResponse); err != nil {
return nil, fmt.Errorf("failed to decode insights response: %w", err)
}
return &insightsResponse, nil
}
// validatePostInsightMetric validates if the provided metric is supported for post insights
func (c *Client) validatePostInsightMetric(metric string) error {
validMetrics := map[string]bool{
string(PostInsightViews): true,
string(PostInsightLikes): true,
string(PostInsightReplies): true,
string(PostInsightReposts): true,
string(PostInsightQuotes): true,
string(PostInsightShares): true,
}
if !validMetrics[metric] {
return NewValidationError(400, "Invalid post insight metric",
fmt.Sprintf("metric '%s' is not supported for post insights", metric), "metric")
}
return nil
}
// validateAccountInsightMetric validates if the provided metric is supported for account insights
func (c *Client) validateAccountInsightMetric(metric string) error {
validMetrics := map[string]bool{
string(AccountInsightViews): true,
string(AccountInsightLikes): true,
string(AccountInsightReplies): true,
string(AccountInsightReposts): true,
string(AccountInsightQuotes): true,
string(AccountInsightClicks): true,
string(AccountInsightFollowersCount): true,
string(AccountInsightFollowerDemographics): true,
}
if !validMetrics[metric] {
return NewValidationError(400, "Invalid account insight metric",
fmt.Sprintf("metric '%s' is not supported for account insights", metric), "metric")
}
return nil
}
// validateInsightPeriod validates if the provided period is supported
func (c *Client) validateInsightPeriod(period string) error {
validPeriods := map[string]bool{
string(InsightPeriodDay): true,
string(InsightPeriodLifetime): true,
}
if !validPeriods[period] {
return NewValidationError(400, "Invalid insight period",
fmt.Sprintf("period '%s' is not supported", period), "period")
}
return nil
}
// validateFollowerDemographicsBreakdown validates the breakdown parameter for follower demographics
func (c *Client) validateFollowerDemographicsBreakdown(breakdown string) error {
validBreakdowns := map[string]bool{
string(BreakdownCountry): true,
string(BreakdownCity): true,
string(BreakdownAge): true,
string(BreakdownGender): true,
}
if !validBreakdowns[breakdown] {
return NewValidationError(400, "Invalid breakdown parameter",
fmt.Sprintf("breakdown '%s' is not supported. Valid values: country, city, age, gender", breakdown), "breakdown")
}
return nil
}
// GetAvailablePostInsightMetrics returns all available post insight metrics
func (c *Client) GetAvailablePostInsightMetrics() []PostInsightMetric {
return []PostInsightMetric{
PostInsightViews,
PostInsightLikes,
PostInsightReplies,
PostInsightReposts,
PostInsightQuotes,
PostInsightShares,
}
}
// GetAvailableAccountInsightMetrics returns all available account insight metrics
func (c *Client) GetAvailableAccountInsightMetrics() []AccountInsightMetric {
return []AccountInsightMetric{
AccountInsightViews,
AccountInsightLikes,
AccountInsightReplies,
AccountInsightReposts,
AccountInsightQuotes,
AccountInsightClicks,
AccountInsightFollowersCount,
AccountInsightFollowerDemographics,
}
}
// GetAvailableInsightPeriods returns all available insight periods
func (c *Client) GetAvailableInsightPeriods() []InsightPeriod {
return []InsightPeriod{
InsightPeriodDay,
InsightPeriodLifetime,
}
}
// GetAvailableFollowerDemographicsBreakdowns returns all available breakdown options for follower demographics
func (c *Client) GetAvailableFollowerDemographicsBreakdowns() []FollowerDemographicsBreakdown {
return []FollowerDemographicsBreakdown{
BreakdownCountry,
BreakdownCity,
BreakdownAge,
BreakdownGender,
}
}