@@ -197,139 +197,6 @@ url-store-by-audit:
197197 security :
198198 - api_key : [ ]
199199
200- url-store-by-platform :
201- parameters :
202- - $ref : ' ./parameters.yaml#/siteId'
203- - name : platformType
204- in : path
205- required : true
206- schema :
207- type : string
208- enum : [primary-site, wikipedia, youtube-channel, reddit-community, facebook-page, twitter-profile, linkedin-company, instagram-account, tiktok-account, github-org, medium-publication]
209- description : Platform type to filter by (e.g., "youtube-channel", "wikipedia")
210- - name : limit
211- in : query
212- required : false
213- schema :
214- type : integer
215- minimum : 1
216- maximum : 500
217- default : 100
218- description : Number of items to return per page
219- - name : cursor
220- in : query
221- required : false
222- schema :
223- type : string
224- description : Pagination cursor from previous response
225- - name : sortBy
226- in : query
227- required : false
228- schema :
229- type : string
230- enum : [rank, traffic, url, createdAt, updatedAt]
231- description : Field to sort by
232- - name : sortOrder
233- in : query
234- required : false
235- schema :
236- type : string
237- enum : [asc, desc]
238- default : asc
239- description : Sort order (ascending or descending)
240- get :
241- tags :
242- - site
243- - url store
244- summary : List URLs by platform type
245- description : |
246- Retrieves URLs filtered by platform type (e.g., social media platforms, Wikipedia, etc.).
247- Results are paginated and sortable.
248- operationId : listUrlsByPlatform
249- responses :
250- ' 200 ' :
251- description : A paginated list of audit URLs for the specified platform type
252- content :
253- application/json :
254- schema :
255- $ref : ' ./schemas.yaml#/AuditUrlListResponse'
256- ' 400 ' :
257- $ref : ' ./responses.yaml#/400'
258- ' 401 ' :
259- $ref : ' ./responses.yaml#/401'
260- ' 403 ' :
261- $ref : ' ./responses.yaml#/403'
262- ' 404 ' :
263- $ref : ' ./responses.yaml#/404-site-not-found-with-id'
264- ' 500 ' :
265- $ref : ' ./responses.yaml#/500'
266- security :
267- - api_key : [ ]
268-
269- url-store-offsite :
270- parameters :
271- - $ref : ' ./parameters.yaml#/siteId'
272- get :
273- parameters :
274- - name : limit
275- in : query
276- required : false
277- schema :
278- type : integer
279- minimum : 1
280- maximum : 500
281- default : 100
282- description : Number of items to return per page
283- - name : cursor
284- in : query
285- required : false
286- schema :
287- type : string
288- description : Pagination cursor from previous response
289- - name : sortBy
290- in : query
291- required : false
292- schema :
293- type : string
294- enum : [rank, traffic, url, createdAt, updatedAt]
295- description : Field to sort by
296- - name : sortOrder
297- in : query
298- required : false
299- schema :
300- type : string
301- enum : [asc, desc]
302- default : asc
303- description : Sort order (ascending or descending)
304- tags :
305- - site
306- - url store
307- summary : List all offsite platform URLs
308- description : |
309- Retrieves all offsite URLs (excludes primary-site URLs).
310- This includes social media profiles, Wikipedia pages, and other external brand presence URLs.
311- Results are paginated and sortable.
312- operationId : listOffsiteUrls
313- responses :
314- ' 200 ' :
315- description : A paginated list of offsite audit URLs
316- content :
317- application/json :
318- schema :
319- $ref : ' ./schemas.yaml#/AuditUrlListResponse'
320- ' 400 ' :
321- $ref : ' ./responses.yaml#/400'
322- ' 401 ' :
323- $ref : ' ./responses.yaml#/401'
324- ' 403 ' :
325- $ref : ' ./responses.yaml#/403'
326- ' 404 ' :
327- $ref : ' ./responses.yaml#/404-site-not-found-with-id'
328- ' 500 ' :
329- $ref : ' ./responses.yaml#/500'
330- security :
331- - api_key : [ ]
332-
333200url-store-get :
334201 parameters :
335202 - $ref : ' ./parameters.yaml#/siteId'
0 commit comments