-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-1.0.0.yaml
1165 lines (1156 loc) · 34.8 KB
/
openapi-1.0.0.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: Trackier Publisher API Docs
description: |
# Introduction
The Trackier API is designed for developers, engineers, or anyone else who’s comfortable creating custom-coded solutions or integrating with RESTful APIs.
Base URL
<li>URL : https://api.trackier.com</li>
<li>Description : Main server</li>
# HTTP Status Code
Review all global errors for the Trackier API so you can get back to work fast. <hr><b>401 - API Key Invalid</b> <br>Your API key may be invalid, or you’ve attempted to access the wrong data center. <br>The current request requires user authentication. For example, the user does not have the necessary credentials. <hr><b>403 - No permissions visit this resource</b> <br>You are not permitted to access this resource. <br>The request was a valid request, but the server is refusing to respond to it. For example, the user does not have the necessary permissions for the resource. <hr><b>404 - Resource Not Found</b> <br>The requested resource could not be found. <br>This error tells you a specific resource doesn’t exist. It’s possible that the resource has been moved or deleted, or that there’s a typo in your request.<hr><b>500 - Server error, Please contact administrator</b> <br>A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.Please contact Support for more information. <br>This error lets you know our servers have experienced a problem. Although this is rare, please contact [email protected] to let us know that you’ve encountered this error
# Authentication
Trackier API endpoints can be authenticated via Header:
- API Key
# Admin API
Admin API can be found here [Admin API](/admin?v=2)
version: v2
termsOfService: 'https://trackier.com/terms-of-service/'
contact:
url: 'https://trackier.com'
name: API Support
email: [email protected]
x-logo:
url: 'https://trackier.com/blog/wp-content/uploads/2019/02/dark-logo.png'
servers:
- url: 'https://api.trackier.com'
description: 'Base URL: https://api.trackier.com'
tags:
- name: Advertiser Campaigns
- name: Advertiser Performance Report
- name: Campaign
- name: Conversion Logs
- name: Coupon Codes
- name: Deals
- name: Performance Report
- name: Publisher Profile
x-tagGroups:
- name: Publisher
tags:
- Campaign
- Coupon Codes
- Deals
- Publisher Profile
- Publisher Profile Edit
- Campaign Request Access
- Allowed Campaign Count
- Performance Report
- Conversion Logs
- Publisher Categories
- name: Advertiser
tags:
- Camapigns
- Advertiser Performance Report
paths:
/v2/publisher/campaigns:
get:
tags:
- Campaign
summary: Fetch All Campaigns
description: |-
Returns all publisher campaigns
Goal: Any additional event added in the campaign is goal
Default Goal: Default event of the campaign
*Note: There will be no goal value in default goal, only goal have the goal values*.
**Rate Limit: 5 req/sec**
operationId: campaigns
parameters:
- in: query
name: page
description: Page number result to fetch
schema:
type: integer
- in: query
name: limit
description: Number of result to fetch in one call (Default => 1000)
schema:
type: integer
- in: query
name: apiKey
description: Publisher API Key
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublisherCampaignData'
'400':
description: Invalid API Key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v2/publishers/profile:
get:
tags:
- Publisher Profile
summary: Fetch Publisher Profile
description: Returns publisher profile
operationId: profile
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
profile:
$ref: '#/components/schemas/PublisherProfile'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Edit Publisher Profile
description: Updates Publisher Profile
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProfileEdit'
operationId: profile-edit
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
publisher:
$ref: '#/components/schemas/PublisherProfile'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Publisher Profile
/v2/publishers/coupons:
get:
tags:
- Coupon Codes
summary: Fetch All Coupons
description: Returns all coupon codes for all campaigns
operationId: coupons
parameters:
- in: query
name: pageToken
description: Token to traverse through paginated data (returns first page if not passed)
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublisherCouponCodeData'
'400':
description: Invalid API Key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/v2/publishers/deals:
get:
tags:
- Deals
summary: Fetch All Deals
description: Returns all deals for all campaigns
operationId: deals
parameters:
- in: query
name: pageToken
description: Token to traverse through paginated data (returns first page if not passed)
schema:
type: string
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublisherDealData'
'400':
description: Invalid API Key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'/v2/publishers/campaign/{id}/access':
post:
summary: Create campaign request access
description: Create campaign request access
operationId: campaign-request-access
parameters:
- schema:
type: string
name: id
in: path
required: true
description: Campaign Id - numeric or hash ID
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Campaign
'/v2/publishers/:pubId/campaignsCount':
get:
summary: Get campaign access count for publisher
description: Get campaign access count for publisher
operationId: campaign-count
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
count:
type: integer
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Campaign
/v2/publishers/reports:
get:
summary: Performance Report
tags:
- Performance Report
description: |-
Performance Report
Default Grouping: campaign_name, campaign_id
Default KPI in response: clicks, approvedConversions, payout, revenue, profit
To update the report grouping or kpi:
- &group[]=campaign_id&group[]=publisher_id
- List of grouping parameters can be found below
- &kpi[]=clicks&kpi[]=rejectedClicks&kpi[]=grossClicks
- List of KPI can be found in query parameter section below
**Rate Limit: 200 req/min**
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
records:
type: array
items:
type: object
properties:
campaign_name:
type: string
campaign_id:
type: integer
currency:
type: string
clicks:
type: integer
approvedConversions:
type: integer
payout:
type: number
revenue:
type: number
profit:
type: number
examples:
example-1:
value:
records:
- campaign_name: test
campaign_id: 21585
currency: USD
clicks: 1
approvedConversions: 8
payout: 2
revenue: 4
profit: 2
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
$ref: '#/components/schemas/Error'
operationId: get-v2-reports-custom
parameters:
- schema:
type: array
in: query
name: group
description: 'Allowed Group parameters: campaign_name, campaign_id, campaign_long_id, external_offer_id, campaign_status, campaign_geo, objective, publisher, publisher_id, publisher_long_id, source, advertiser, advertiser_id, goal_name, goal_id, ref_camp, ref_camp_id, lp_title, lp_id, os, country, hour, created, month'
- schema:
type: array
in: query
name: kpi
description: 'Allowed KPIs: uniqueClicks, rejectedClicks, clicks, grossClicks, approvedConversions, pendingConversions, cancelledConversions, rejectedConversions, extConversions, grossConversions, cr, impressions, campaign_payout, campaign_revenue, payout, revenue, profit, saleAmount, pendingPayout, pendingSaleAmount, extPayout, extSaleAmount, extRevenue, grossRevenue, grossProfit, grossSaleAmount, epc, ctr'
- schema:
type: array
in: query
name: camp_ids
description: 'To filter the report for a particular campaign add campaign id in query parameters like: &camp_ids[]=16&camp_ids[]=30'
- schema:
type: string
in: query
name: start
description: Report start date in YYYY-MM-DD format
- schema:
type: string
in: query
name: end
description: Report end date in YYYY-MM-DD format
security:
- API Key: []
/v2/publishers/conversions:
get:
summary: Conversion Logs
tags:
- Conversion Logs
description: Conversion Logs
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
conversions:
type: array
items:
type: object
properties:
_id:
type: string
click_id:
type: string
source:
type: string
elapsed_time:
type: integer
city:
type: string
region:
type: string
isp:
type: string
p1:
type: string
p2:
type: string
p3:
type: string
p4:
type: string
p5:
type: string
p6:
type: string
p7:
type: string
p8:
type: string
p9:
type: string
p10:
type: string
os:
type: string
goal_id:
type: string
nullable: true
txn_id:
type: string
nullable: true
currency:
type: string
payout:
type: number
orig_sale_currency:
type: string
country:
type: string
browser:
type: string
device:
type: string
created:
type: string
status:
type: string
external_offer_id:
type: string
campaign_id:
type: integer
campaign_name:
type: string
goal_name:
type: string
url_title:
type: string
examples:
example-1:
value:
conversions:
- _id: 789945425c4d250355fd58b
click_id: 647945425c4d250355fd476a
source: testery
elapsed_time: 0
city: Philadelphia
region: Pennsylvania
isp: Comcast Cable
p1: ''
p2: ''
p3: ''
p4: ''
p5: ''
p6: ''
p7: ''
p8: ''
p9: ''
p10: ''
os: Android 11.0
goal_id: null
txn_id: null
currency: USD
payout: 0
orig_sale_currency: USD
country: US
browser: Chrome 97
device: mobile
created: '2023-06-02T01:28:40.000Z'
status: approved
external_offer_id: '32'
campaign_id: 2
campaign_name: string
goal_name: Install
url_title: Default
pagination:
perPage: 100
currentPage: 1
total: 1000
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
$ref: '#/components/schemas/Error'
operationId: get-v2-network-pubConversions
parameters:
- schema:
type: integer
in: query
name: limit
description: 'No of records per page. Min: 100, Max: 1000'
- schema:
type: integer
in: query
name: page
description: Current page number
- schema:
type: string
in: query
name: start
description: Report start date in YYYY-MM-DD format
required: true
- schema:
type: string
in: query
name: end
description: Report end date in YYYY-MM-DD format
required: true
- schema:
type: string
in: query
name: click_id
description: Click Id
- schema:
type: string
in: query
name: p1
description: P1
- schema:
type: string
in: query
name: p2
description: P2
- schema:
type: string
in: query
name: p3
description: P3
- schema:
type: string
in: query
name: p4
description: P4
- schema:
type: string
in: query
name: p5
description: P5
- schema:
type: string
enum:
- approved
- pending
- cancelled
- rejected
in: query
name: status
allowReserved: false
description: Conversion Status
security:
- API Key: []
/v2/publishers/reports-kpi:
get:
summary: Performance Report GET KPI
tags:
- Performance Report
description: Performance Report GET KPI Method
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
allowedGrouping:
type: array
allowedKpi:
type: array
groupingMap:
type: object
kpiMap:
type: object
examples:
example-1:
value:
allowedGrouping:
- campaign_name
- campaign_id
- campaign_long_id
- campaign_status
allowedKpi:
- uniqueClicks
- clicks
- grossClicks
- impressions
- payout
groupingMap:
campaign_name: Campaign
campaign_id: Campaign ID
campaign_long_id: Campaign Long ID
campaign_status: Campaign Status
campaign_geo: Campaign GEO
kpiMap:
uniqueClicks: Unique Clicks
clicks: Clicks
grossClicks: Gross Clicks
impressions: Impressions
payout: Payout
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
$ref: '#/components/schemas/Error'
operationId: get-v2-reports-get-kpi
security:
- API Key: []
/v2/publishers/categories:
get:
summary: Fetch All Categories
operationId: Publisher-Categories
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
categories:
type: array
items:
type: object
properties:
_id:
type: string
name:
type: string
created:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
errors:
$ref: '#/components/schemas/Error'
description: Use this endpoint to fetch all Publisher Categories
tags:
- Campaign
security:
- API Key: []
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
format: int32
type:
type: string
message:
type: string
Payout:
type: object
properties:
payout:
description: Payout of the campaign
type: number
format: float
example: 1.87
fixedPayout:
description: Payout of the campaign
type: number
format: float
example: 1.87
geo:
description: List of all Payout geo
type: array
example:
- US
- IN
city:
description: List of Cities
type: array
example:
- Mohali
region:
description: List of Region
type: array
example:
- Punjab
allowedValues:
description: List of Allowed Values corresponding to the variable
type: array
example:
- sub1-testing
- sub2-testing
variable:
type: string
example: source
enum:
- p1
- p2
- p3
- p4
- p5
- p6
- p7
- p8
- p9
- p10
- source
Goal:
type: object
properties:
id:
description: Goal ID
type: string
example: 5cebd00db6920d7e89622ccf
title:
description: Goal Title
type: string
example: Purchased
value:
description: Goal Value
type: string
example: Purchased
payout_model:
description: Payout Model
type: string
example: fixed
payouts:
description: List of Goal Payouts
type: array
items:
$ref: '#/components/schemas/Payout'
OsVer:
type: object
properties:
min:
type: string
example: '4.1'
description: Minimum OS version
max:
type: string
example: '9'
description: Maximum OS version
PublisherCampaign:
type: object
properties:
id:
description: Campaign/Offer ID
type: integer
example: 18
title:
description: Campaign name
type: string
example: AppAttribution CPI-Incent
description:
description: Campaign Description
type: string
example: AppAttribution mobile app platform
nullable: true
kpi:
description: Campaign kpi
type: string
example: mobile app platform
nullable: true
currency:
description: <span class='description'>If currency is present then the payout shown by the API for that campaign is in that currency.</span> <span class='description'>If no currency then it should be assumed as USD and accordingly payout is also in USD</span>
type: string
example: USD
enum:
- INR
- USD
- EUR
nullable: true
categories:
description: Campaign categories
type: array
example:
- Technology
- Bollynews
nullable: true
items: {}
subIdsBlock:
description: List of Blocked Sub IDs
type: array
example:
- XF152asd
- TF152asd
nullable: true
items: {}
subIdsAllow:
description: List of Allowed Sub IDs
type: array
example:
- XF152asd
- TF152asd
nullable: true
items: {}
preview_url:
description: Destination url of the campaign
type: string
example: 'https://play.google.com/store/apps/details?id=io.appattribution.device'
nullable: true
model:
description: '<span class=''description''>Also if model is CPS then the payout is in percentage (Example: if payout = 70 and model = CPS, then it means payout is 70% of the sale amount not $70)</span>'
type: string
example: cpi
enum:
- cpa
- cpi
- cpc
- cpm
- cps
device:
description: List of all supported devices
type: array
items:
x-stoplight:
id: 6k9z4r9knvq8q
enum:
- mobile
- desktop
- tablet
- all
flow:
description: Conversion Flow
type: array
example:
- MO Flow
nullable: true
items: {}
os:
description: List of all operating system supported
type: array
items:
x-stoplight:
id: zjaxz8egkf745
enum:
- android
- ios
- all
os_version:
description: List of all supported os version
type: object
nullable: true
properties:
ios:
type: object
$ref: '#/components/schemas/OsVer'
android:
type: object
$ref: '#/components/schemas/OsVer'
windowsphone:
type: object
$ref: '#/components/schemas/OsVer'
all:
type: object
$ref: '#/components/schemas/OsVer'
app_id:
description: 'Application id, e.g com.example.android (Android) or id4298877253 (iOS)'
type: string
example: io.appattribution.app
nullable: true
app_name:
description: Application name
type: string
example: AppAttribution - Mobile App Tracking
nullable: true
tracking_link:
description: Tracking link of the campaign/offer
type: string
example: 'https://trk.trackier.com/5acdefeadcxwe3dsad?p1={your-transaction-id}&source={your-sub-aff-id}'
impressionUrl:
description: Impression URL of the campaign/offer
type: string
example: 'https://demo.trackier.net/imp?campaign_id=20931&pub_id=31'
bot_check_url:
description: Botman Bot Check URL
type: string
example: 'https://a762.botninja.js?https://demo.trackier.net/5acdefeadcxwe3dsad'
nullable: true
countries:
description: List of all supported countries
type: array
example:
- US
- IN
items: {}
isps:
description: Allowed ISPs List
type: array
example:
- SpectraNet
- ASN
items: {}
citiesInclude:
description: Allowed Cities List
type: array
example:
- Kolkata
- Delhi
items: {}
citiesExclude:
description: Blocked Cities List
type: array
example:
- Kolkata
- Delhi
items: {}
defaultGoal:
description: Default Goal name
type: string
example: Install
payouts:
description: List of payouts
type: array
items:
$ref: '#/components/schemas/Payout'
goals:
description: List of goals
type: array
items:
$ref: '#/components/schemas/Goal'
creatives:
description: List of creatives associated with campaign
type: array
nullable: true
items:
$ref: '#/components/schemas/Creatives'
cap:
type: object
description: CAP information
properties:
type:
type: string
example: conversion
daily:
type: number
example: 0
monthly:
type: number
example: 928
lifetime:
type: number
example: 0
Error:
type: object
properties:
success:
type: boolean
description: Response status
example: false
error:
type: object
properties:
code:
description: Error code
type: integer
example: 13
message:
description: Error message
type: string
example: Invalid API Key
PublisherProfile:
type: object
properties:
name:
type: string
email:
type: string
phone:
type: string
status:
type: string
hashId:
type: string
company:
type: string
id:
type: string
ProfileEdit:
type: object
properties:
name:
type: string