-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
2900 lines (2887 loc) · 88.5 KB
/
openapi.yaml
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: SEOmonitor API
description: >-
`
We have now released the new `<a href='https://api-docs.seomonitor.com/'>API
3.0</a>`!
It comes with enhanced data coverage and organization, and easy-to-use
documentation.
This version will continue to be functional, and you can use it alongside
the new version, if needed.`
version: '1.2'
servers:
- description: SEOmonitor API
url: https://api.internal.seomonitor.com/api/v1.2
tags:
- name: Groups
- name: Compare
- name: Keyword Data
- name: Forecast
- name: Ranks
- name: Organic Traffic
- name: Visibility Score
- name: Sites
- name: Content Performance
- name: Keyword SERP
- name: Devices
paths:
/keyword_canibalization/{site_id}/{group_id}:
get:
tags:
- Keyword Data
summary: Keyword Canibalization
operationId: KeywordData_listCanibalizationKeywords
security:
- Authorization: []
description: |
List of keywords with canibalization issues
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
- description: The unique group identifier. 0 for 'All keywords'
name: group_id
in: path
required: true
type: integer
- description: Start Date
name: start_date
in: path
required: false
type: integer
- description: End Date
name: end_date
in: path
required: false
type: integer
responses:
'200':
description: An array of keywords
schema:
type: array
items: {}
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/sites:
get:
tags:
- Sites
summary: Sites
operationId: Sites_getList
security:
- Authorization: []
description: |
List of sites available in your account.
responses:
'200':
description: An array of sites
schema:
type: array
items:
$ref: '#/definitions/Site'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/on_target/{site_id}:
get:
tags:
- Forecast
summary: Forecast
operationId: Forecast_trafficForecastStatus
security:
- Authorization: []
description: |
Traffic forecast status.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
responses:
'200':
description: ''
schema:
type: array
items:
$ref: '#/definitions/ForecastExample'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/on_target/by_dates/{site_id}:
get:
tags:
- Forecast
summary: Objective/Forecast
operationId: Forecast_objectiveData
security:
- Authorization: []
description: It returns the forecast data for the set objective
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
google_sheets:
label: Site
responses:
'200':
description: >-
It returns the traffic forecast data for the last 12 months for the
selected website, such as: month, search volume, real traffic,
estimated traffic and visibility score.
schema:
type: array
items:
$ref: '#/definitions/ForecastExampleByDates'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: true
header:
date:
name: Month
format_rule: format_date_month
note: null
colWidth: 65
style_rule: alignment_center
real_traffic:
name: |-
Actual
Traffic
format_rule: format_number
note: >-
This is the actual non-brand organic traffic for the forecasted
months that already passed.
colWidth: 90
style_rule: alignment_right
inertial_traffic:
name: |-
Est. Inertial
Traffic
format_rule: format_number
note: >-
The estimated monthly non-brand organic traffic if there's no SEO
progress or decrease in the selected timeframe. The estimations
are based on the current values and then extrapolated using the
seasonality and trends of the keywords that generate the
Forecast.
This estimations are used to calculate the impact in non-brand organic traffic when the objective will be achieved.
colWidth: 90
style_rule: alignment_right
estimated_traffic:
name: |-
Est. Improved
Traffic
format_rule: format_number
note: >-
This is the initial forecasted non-brand organic traffic
(monthly), based on achieving the selected SEO goals in the chosen
timeframe.
colWidth: 100
style_rule: alignment_right
estimated_additional_traffic:
name: |-
Additional
Traffic
format_rule: format_number
note: >-
This is the monthly estimated impact of the targeted SEO progress.
It is the difference between the estimated Improved Traffic and
the estimated Inertial Traffic.
colWidth: 90
style_rule: alignment_right
search_volume:
name: |-
Search
Seasonality
format_rule: format_number
note: >-
This is the total monthly Search Volume of the tracked keywords,
which informs our forecasting algorithm on the search seasonality.
colWidth: 90
style_rule: alignment_right
error: |-
There is no forecast set as objective.
You can configure one here: https://app.seomonitor.com/param_0/forecast
/keyword_groups/{site_id}/{date_start}/{date_end}:
get:
tags:
- Groups
summary: Keyword Groups
operationId: Groups_getKeywordGroups
security:
- Authorization: []
description: >-
DEPRECATED<br>
Use groups_list and group_details instead.<br><br>
The details for the keyword groups for a specific site.
<br/><strong>Warning:</strong> Group details are only available when
providing the <b>load_keyword_ids</b> parameter with a value of
<b>1</b>.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
By default, a request is limited to 1000 groups (or 10 if
load_keywords_ids is active), if you want more you can set the
offset
name: offset
in: query
type: number
- description: >-
By default, a request is limited to 1000 groups (or 10 if
load_keywords_ids is active). Use the limit parameter to change the
number of results per request (max. 10 if load_keyword_ids is
active)
name: limit
in: query
type: number
- description: >-
Loads Keyword IDs in the keywords array if set to 1. When active,
the response is limited to 10 groups
name: load_keyword_ids
in: query
type: number
responses:
'200':
description: An array of groups
schema:
type: array
items:
$ref: '#/definitions/KeywordGroups'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
deprecated: true
google_sheets:
show: false
/groups_list/{site_id}:
get:
info: >-
It returns Group ID, Group name and Group type (normal or smart) for the
selected website.
tags:
- Groups
summary: Groups List
operationId: Groups_getList
security:
- Authorization: []
description: |
Group List.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
google_sheets:
label: Site
responses:
'200':
description: >-
It returns Group ID, Group name and Group type (normal or smart) for
the selected website.
schema:
type: array
items:
$ref: '#/definitions/GroupsList'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/group_details/{site_id}/{group_id}/{date_start}/{date_end}:
get:
tags:
- Groups
summary: Group Performance
operationId: Groups_getPerformanceData
security:
- Authorization: []
description: >-
Returns the keyword count, the search volumes, the desktop and mobile
visibility at the end of the period and the performance-related
visibility changes for the timeframe.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
google_sheets:
label: Site
- description: The group identifier
name: group_id
in: path
required: true
type: integer
google_sheets:
label: Group
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
google_sheets:
label: Start Date
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
google_sheets:
label: End Date
responses:
'200':
description: An array of groups
schema:
type: array
items:
$ref: '#/definitions/GroupDetails'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: true
title_param: group
secondary_header:
search_data:
name: SEARCH DATA
columns: 4
background_color: '#0c343d'
color: '#ffffff'
full_columns_color: false
alignment: left
desktop_visibility:
name: DESKTOP VISIBILITY
columns: 2
background_color: '#4a86e8'
color: '#ffffff'
full_columns_color: '#ecf8ff'
alignment: left
mobile_visibility:
name: MOBILE VISIBILITY
columns: 2
background_color: '#6aa84f'
color: '#ffffff'
full_columns_color: '#eeffed'
alignment: left
header:
group_name:
name: Group
colWidth: 250
style_rule: alignment_left
kw_count:
name: Keywords
format_rule: format_number
note: Number of keywords in each group.
colWidth: 75
style_rule: alignment_right
search_volume:
name: |-
Search
Volume
format_rule: format_number
colWidth: 80
style_rule: alignment_right
yoy.value:
name: |-
YoY
Trend
format_rule: percent
style_rule: percent_sign, alignment_right
note: Year-over-Year search trend.
colWidth: 65
vscore_stop_desktop:
name: Visibility
format_rule: percent
style_rule: percent_round, alignment_right
note: The desktop Visibility in the last day of the timeframe.
colWidth: 70
desktop_performance_change:
name: Change
format_rule: percent
style_rule: sign_color_percent, bold, alignment_right
note: >-
The performance-related change in desktop Visibility for the given
timeframe.
Read more about this here - https://help.seomonitor.com/en/articles/886067-understanding-changes-in-visibility
colWidth: 65
vscore_stop_mobile:
name: Visibility
format_rule: percent
style_rule: percent_round, alignment_right
note: The mobile Visibility in the last day of the timeframe.
colWidth: 70
mobile_performance_change:
name: Change
format_rule: percent
style_rule: sign_color_percent, bold, alignment_right
note: >-
The performance-related change in mobile Visibility for the given
timeframe.
Read more about this here - https://help.seomonitor.com/en/articles/886067-understanding-changes-in-visibility
colWidth: 65
/all_group_details/{site_id}/{date_start}/{date_end}:
get:
info: >-
It returns the group name, number of keywords, total search volume for
the keywords, desktop and mobile visibility score at the start of the
period, desktop and mobile visibility score at the end of the period and
desktop and mobile visibility score performance change for all groups
tags:
- Groups
summary: Group performance
operationId: Groups_getKeywordsDetails
security:
- Authorization: []
description: |
Keywords details for all groups
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
responses:
'200':
description: An array of groups
schema:
type: array
items:
$ref: '#/definitions/AllGroupDetails'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/keyword_data/{site_id}/{date_start}/{date_end}:
get:
info: >-
It returns the name, search volume, cost per click, date and time the
keyword was added, landing page for desktop and mobile in google for the
keyword for this site, total visits, bounces, conversions, conversion
rate, conversions value, goals, goals rate, goals value, last position
both desktop and mobile, the difference between the first position in
the period and the last position in the period both desktop and mobile,
visibility impact (similar to a weighted average) both desktop and
mobile, the group the keyword is in and estimated additional traffic,
revenue and AdWords cost once in Top 3
tags:
- Keyword Data
summary: Keyword Data
operationId: KeywordData_getDetails
security:
- Authorization: []
description: |
All SEO Campaign section keywords details.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
By default a request is limited to 1000 rows, if you want more you
can set the offset
name: offset
in: query
type: number
- description: The keyword name you wish to retrieve data for
name: keyword_name
in: query
required: false
type: string
responses:
'200':
description: An array of keywords details
schema:
type: array
items:
$ref: '#/definitions/KeywordData'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/keyword_data/{site_id}/{group_id}/{date_start}/{date_end}:
get:
tags:
- Keyword Data
summary: Keyword Performance
operationId: KeywordData_getPerformance
security:
- Authorization: []
description: >-
Returns all keyword data including ranking performance on both devices
in the selected timeframe.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
google_sheets:
label: Site
- description: Group id. For Brand folder you can use `brand` as value for group id
name: group_id
in: path
required: true
type: integer
google_sheets:
label: Group
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
google_sheets:
label: Start Date
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
google_sheets:
label: End Date
- description: >-
By default, a request is limited to 1000 rows. If you need to get
more, you can set an offset, accordingly (an offset of 1000 will
provide the following 1000 rows).
For example, if you need rows 3000-4000, you would set the offset at 3000.
name: offset
in: query
type: number
google_sheets:
hide: true
label: Offset
- description: The keyword (name, not ID) you need data for.
name: keyword_name
in: query
required: false
type: string
google_sheets:
label: Keyword Filter
placeholder: Enter Keyword
responses:
'200':
description: Keyword details for a specific group.
schema:
type: array
items:
$ref: '#/definitions/KeywordData'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: true
title_param: group
lockColumns: 4
lockRows: 4
sort: 2
secondary_header:
search_data:
name: SEARCH DATA
columns: 4
background_color: '#0c343d'
color: '#ffffff'
full_columns_color: false
alignment: left
desktop_ranking_data:
name: DESKTOP RANKING DATA
columns: 4
background_color: '#4a86e8'
color: '#ffffff'
full_columns_color: '#ecf8ff'
alignment: left
mobile_ranking_data:
name: MOBILE RANKING DATA
columns: 4
background_color: '#6aa84f'
color: '#ffffff'
full_columns_color: '#eeffed'
alignment: left
traffic_data:
name: TRAFFIC DATA
columns: 5
background_color: '#1c4587'
color: '#ffffff'
full_columns_color: false
alignment: left
opportunity:
name: OPPORTUNITY
columns: 3
background_color: '#351c75'
color: '#ffffff'
full_columns_color: false
alignment: left
other:
name: OTHER
columns: 4
background_color: '#000000'
color: '#ffffff'
full_columns_color: false
alignment: left
header:
keyword_data.name:
name: Keyword
note: Keyword Name
format_rule: ''
style_rule: alignment_left
colWidth: 155
keyword_data.average_search_volume:
name: |-
Search
Volume
note: Monthly searches on the keyword.
format_rule: format_number
style_rule: alignment_right
colWidth: 65
keyword_data.yoy:
name: |-
YOY
Trend
note: Year-over-Year search trend.
format_rule: percent
style_rule: percent_round, alignment_right
colWidth: 55
keyword_data.average_cpc:
name: CPC
note: Cost Per Click
format_rule: number_two_decimal
style_rule: alignment_right
colWidth: 55
position:
name: Rank
note: The desktop rank in the last day of the timeframe.
format_rule: max_99
style_rule: alignment_right
colWidth: 55
position_trend:
name: Change
note: The change in desktop rank for the given timeframe.
format_rule: ''
style_rule: sign_color, bold, alignemnt_right
colWidth: 55
visibility_impact_desktop:
name: |-
Visibility
Impact
note: >-
The impact of this keyword's rank change in the desktop Visibility
change for the given timeframe.
Read more about the performance-related Visibility changes here - https://help.seomonitor.com/en/articles/886067-understanding-changes-in-visibility
format_rule: ''
style_rule: sign_color, alignment_right
colWidth: 65
keyword_data.landing_page:
name: Landing Page
format_rule: landing_page
style_rule: alignment_left
note: The ranking landing page in the desktop search.
colWidth: 130
position_mobile:
name: Rank
format_rule: max_99
style_rule: alignment_right
note: The mobile rank in the last day of the timeframe.
colWidth: 55
position_trend_mobile:
name: Change
format_rule: ''
style_rule: sign_color, bold, alignment_right
note: The change in mobile rank for the given timeframe.
colWidth: 55
visibility_impact_mobile:
name: |-
Visibility
Impact
format_rule: ''
style_rule: sign_color, alignment_right
note: >-
The impact of this keyword's rank change in the mobile Visibility
change for the given timeframe.
Read more about the performance-related Visibility changes here - https://help.seomonitor.com/en/articles/886067-understanding-changes-in-visibility
colWidth: 65
keyword_data.landing_page_mobile:
name: Landing Page
format_rule: landing_page
style_rule: alignment_left
note: The ranking landing page in the mobile search.
colWidth: 130
visits:
name: Sessions
format_rule: format_number
style_rule: alignment_right
note: Non-brand organic visits on the keyword, for the given timeframe.
colWidth: 65
bounces:
name: Bounces
note: Percentage of single-page sessions.
format_rule: format_number
style_rule: alignment_right
colWidth: 65
conversions_goals:
name: Conversions
note: Number of completed goals, based on the Analytics selection.
format_rule: format_number
style_rule: alignment_right
colWidth: 87
conversions_goals_rate:
name: |-
Conv.
Rate
note: Percentage of Conversions resulting from the organic sessions.
format_rule: number_two_decimal
style_rule: alignment_right
colWidth: 45
revenue_value:
name: |-
Revenue/
Value
note: Percentage of single-page sessions.
format_rule: format_number
style_rule: alignment_right
colWidth: 70
keyword_data.top_10_difficulty:
name: |-
Top 10
Difficulty
format_rule: ''
style_rule: alignment_right
note: The difficulty for the landing page to reach Top 10.
colWidth: 75
keyword_data.opportunity:
name: Opportunity
note: >-
The effort necessary to reach the top versus the monthly estimated
value (revenue) generated after that.
format_rule: ''
style_rule: alignment_right
colWidth: 80
keyword_data.lables_warning:
name: |-
Labels &
Warnings
format_rule: ''
style_rule: alignment_left
note: Helpful labels and/or warnings automatically added to the keyword.
colWidth: 95
group_name:
name: Groups
note: Groups in which the keyword is present.
format_rule: ''
style_rule: alignment_left
colWidth: 75
keyword_data.date_added:
name: Date Added
format_rule: format_date
style_rule: alignment_center
note: The date when the keyword started being tracked in the campaign.
colWidth: 80
keyword_data.main_keyword_id:
name: Main Keyword ID
format_rule: ''
style_rule: alignment_center
colWidth: 60
keyword_data.close_variation:
name: Close Variation
format_rule: ''
style_rule: alignment_center
note: If the keyword is a close variation of other keyword.
colWidth: 80
/ranks/{site_id}/{date_start}/{date_end}:
get:
info: >-
It returns both desktop and mobile position for each date in your
selected interval
tags:
- Ranks
summary: Ranks
operationId: Ranks_getDesktopMobileRanks
security:
- Authorization: []
description: |
Desktop and mobile ranks
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
- description: >-
By default a rank request is limited to 100 keywords, if you want
the next 100 keywords you can set the offset
name: offset
in: query
type: number
- description: >-
If this field is not set, default value is 100.If this field is set,
allowed values are between 100 and 1000
name: limit
in: query
type: number
responses:
'200':
description: An array of positions grouped by keyword
schema:
type: array
items:
$ref: '#/definitions/Ranks'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
google_sheets:
show: false
/ranks/{site_id}/{date_start}/{date_end}/{group_id}:
get:
info: >-
It returns both desktop and mobile position for each date in your
selected interval filtered by group
tags:
- Ranks
summary: Keywords Ranks
operationId: Ranks_getGroupRanks
security:
- Authorization: []
description: >-
Returns both desktop and mobile ranks for each day in the selected
interval, filtered by group.
parameters:
- description: The unique site identifier
name: site_id
in: path
required: true
type: integer
google_sheets:
label: Site
- description: The unique group identifier
name: group_id
in: path
required: true
type: string
format: integer
google_sheets:
label: Group
- description: >-
The start of the period. (Accepts date format as YYYY-mm-dd or
relative like "1 week ago", "3 months ago", etc.)
name: date_start
in: path
required: true
type: string
format: YYYY-mm-dd or relative
google_sheets:
label: Start Date
- description: >-
The end of the period. (Accepts date format as YYYY-mm-dd or
relative like "now", "today", etc.)
name: date_end
in: path
required: true
type: string
format: YYYY-mm-dd or relative
google_sheets:
label: End Date