Skip to content

page_gaps

page_gaps

delete_bulk_page_type_id async 

delete_bulk_page_type_id(
    auth: DomoAuth,
    type: str,
    id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

DELETE /api/content/v1/share/bulk/page/{type}/{id} - Remove sharing for a specific page.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
type str

Type of sharing entity (e.g., 'user', 'group', 'domain').

 required
id str

ID of the entity whose access is being revoked.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the removal result.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def delete_bulk_page_type_id(
    auth: DomoAuth,
    type: str,
    id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """DELETE /api/content/v1/share/bulk/page/{type}/{id} - Remove sharing for a specific page.

    Args:
        auth: Authentication object containing Domo credentials.
        type: Type of sharing entity (e.g., 'user', 'group', 'domain').
        id: ID of the entity whose access is being revoked.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the removal result.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/share/bulk/page/{type}/{id}"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="DELETE",
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="DELETE /content/v1/share/bulk/page/{type}/{id} failed", res=res
        )
    return res

delete_content_pages_analyzer_filterviewid async 

delete_content_pages_analyzer_filterviewid(
    auth: DomoAuth,
    filterViewId: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

DELETE /api/content/v3/pages/analyzer/{filterViewId} - Delete a saved analyzer filter view.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
filterViewId str

ID of the filter view to delete.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the deletion result.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def delete_content_pages_analyzer_filterviewid(
    auth: DomoAuth,
    filterViewId: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """DELETE /api/content/v3/pages/analyzer/{filterViewId} - Delete a saved analyzer filter view.

    Args:
        auth: Authentication object containing Domo credentials.
        filterViewId: ID of the filter view to delete.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the deletion result.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v3/pages/analyzer/{filterViewId}"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="DELETE",
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="DELETE /content/v3/pages/analyzer/{filterViewId} failed", res=res
        )
    return res

delete_pages_page_id_collections_page_collection_id async 

delete_pages_page_id_collections_page_collection_id(
    auth: DomoAuth,
    page_id: str,
    page_collection_id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

DELETE /api/v1/pages/{page_id}/collections/{page_collection_id} - Remove a page from a collection.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
page_id str

ID of the page to remove from the collection.

 required
page_collection_id str

ID of the collection membership to delete.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the result of removing the page from the collection.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def delete_pages_page_id_collections_page_collection_id(
    auth: DomoAuth,
    page_id: str,
    page_collection_id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """DELETE /api/v1/pages/{page_id}/collections/{page_collection_id} - Remove a page from a collection.

    Args:
        auth: Authentication object containing Domo credentials.
        page_id: ID of the page to remove from the collection.
        page_collection_id: ID of the collection membership to delete.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the result of removing the page from the collection.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/v1/pages/{page_id}/collections/{page_collection_id}"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="DELETE",
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="DELETE /v1/pages/{page_id}/collections/{page_collection_id} failed",
            res=res,
        )
    return res

get_content_pages_analyzer_filterviewid async 

get_content_pages_analyzer_filterviewid(
    auth: DomoAuth,
    filterViewId: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/content/v3/pages/analyzer/{filterViewId} - Get details for a saved analyzer filter view.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
filterViewId str

ID of the filter view to retrieve.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the filter view details.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def get_content_pages_analyzer_filterviewid(
    auth: DomoAuth,
    filterViewId: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v3/pages/analyzer/{filterViewId} - Get details for a saved analyzer filter view.

    Args:
        auth: Authentication object containing Domo credentials.
        filterViewId: ID of the filter view to retrieve.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the filter view details.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v3/pages/analyzer/{filterViewId}"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="GET /content/v3/pages/analyzer/{filterViewId} failed", res=res
        )
    return res

get_content_pages_navigation async 

get_content_pages_navigation(
    auth: DomoAuth,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/content/v2/pages/navigation - Get the page navigation structure.

Retrieves the hierarchical page structure for use in navigation UI.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the page navigation hierarchy.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def get_content_pages_navigation(
    auth: DomoAuth,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v2/pages/navigation - Get the page navigation structure.

    Retrieves the hierarchical page structure for use in navigation UI.

    Args:
        auth: Authentication object containing Domo credentials.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the page navigation hierarchy.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v2/pages/navigation"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )
    if not res.is_success:
        raise RouteError(message="GET /content/v2/pages/navigation failed", res=res)
    return res

get_pages_page_id_collections async 

get_pages_page_id_collections(
    auth: DomoAuth,
    page_id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/v1/pages/{page_id}/collections - Get collections for a page.

Retrieves the list of collections that a page belongs to.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
page_id str

ID of the page whose collections are being retrieved.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the list of collections for the page.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def get_pages_page_id_collections(
    auth: DomoAuth,
    page_id: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/v1/pages/{page_id}/collections - Get collections for a page.

    Retrieves the list of collections that a page belongs to.

    Args:
        auth: Authentication object containing Domo credentials.
        page_id: ID of the page whose collections are being retrieved.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the list of collections for the page.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/v1/pages/{page_id}/collections"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )
    if not res.is_success:
        raise RouteError(message="GET /v1/pages/{page_id}/collections failed", res=res)
    return res

get_pages_pageid_analyzer_named async 

get_pages_pageid_analyzer_named(
    auth: DomoAuth,
    pageId: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

GET /api/content/v3/pages/{pageId}/analyzer/named - Get named analyzer filter views for a page.

Retrieves all saved analyzer filter views associated with the specified page.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
pageId str

ID of the page whose analyzer views are being retrieved.

 required
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the list of named analyzer views.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def get_pages_pageid_analyzer_named(
    auth: DomoAuth,
    pageId: str,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """GET /api/content/v3/pages/{pageId}/analyzer/named - Get named analyzer filter views for a page.

    Retrieves all saved analyzer filter views associated with the specified page.

    Args:
        auth: Authentication object containing Domo credentials.
        pageId: ID of the page whose analyzer views are being retrieved.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the list of named analyzer views.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v3/pages/{pageId}/analyzer/named"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="GET /content/v3/pages/{pageId}/analyzer/named failed", res=res
        )
    return res

post_content_pages_adminsummary async 

post_content_pages_adminsummary(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

POST /api/content/v1/pages/adminsummary - Get pages admin summary.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
body dict[str, Any] | list[Any] | None

Request body with admin summary parameters.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the admin summary response.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def post_content_pages_adminsummary(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """POST /api/content/v1/pages/adminsummary - Get pages admin summary.

    Args:
        auth: Authentication object containing Domo credentials.
        body: Request body with admin summary parameters.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the admin summary response.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/adminsummary"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(message="POST /content/v1/pages/adminsummary failed", res=res)
    return res

post_pages_bulk_owners_remove async 

post_pages_bulk_owners_remove(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

POST /api/content/v1/pages/bulk/owners/remove - Remove owners from multiple pages.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
body dict[str, Any] | list[Any] | None

Request body with page IDs and owner IDs to remove.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the removal operation response.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
 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
async def post_pages_bulk_owners_remove(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """POST /api/content/v1/pages/bulk/owners/remove - Remove owners from multiple pages.

    Args:
        auth: Authentication object containing Domo credentials.
        body: Request body with page IDs and owner IDs to remove.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the removal operation response.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = (
        f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/bulk/owners/remove"
    )
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="POST /content/v1/pages/bulk/owners/remove failed", res=res
        )
    return res

post_pages_page_id_collections async 

post_pages_page_id_collections(
    auth: DomoAuth,
    page_id: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

POST /api/v1/pages/{page_id}/collections - Add a page to a collection.

Adds the specified page to a collection.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
page_id str

ID of the page to add to a collection.

 required
body dict[str, Any] | list[Any] | None

Request body with collection ID and other parameters.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the result of adding the page to the collection.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def post_pages_page_id_collections(
    auth: DomoAuth,
    page_id: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """POST /api/v1/pages/{page_id}/collections - Add a page to a collection.

    Adds the specified page to a collection.

    Args:
        auth: Authentication object containing Domo credentials.
        page_id: ID of the page to add to a collection.
        body: Request body with collection ID and other parameters.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the result of adding the page to the collection.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/v1/pages/{page_id}/collections"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(message="POST /v1/pages/{page_id}/collections failed", res=res)
    return res

post_pages_pageid_cards_cardid async 

post_pages_pageid_cards_cardid(
    auth: DomoAuth,
    pageId: str,
    cardId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

POST /api/content/v1/pages/{pageId}/cards/{cardId} - Perform action on a specific card.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
pageId str

ID of the page containing the card.

 required
cardId str

ID of the card to act upon.

 required
body dict[str, Any] | list[Any] | None

Request body with card action parameters.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the card action response.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def post_pages_pageid_cards_cardid(
    auth: DomoAuth,
    pageId: str,
    cardId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """POST /api/content/v1/pages/{pageId}/cards/{cardId} - Perform action on a specific card.

    Args:
        auth: Authentication object containing Domo credentials.
        pageId: ID of the page containing the card.
        cardId: ID of the card to act upon.
        body: Request body with card action parameters.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the card action response.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/{pageId}/cards/{cardId}"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="POST /content/v1/pages/{pageId}/cards/{cardId} failed", res=res
        )
    return res

put_content_pages_bulk_move async 

put_content_pages_bulk_move(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/pages/bulk/move - Move multiple pages to a different location.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
body dict[str, Any] | list[Any] | None

Request body with page IDs and target location.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the move operation response.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def put_content_pages_bulk_move(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/pages/bulk/move - Move multiple pages to a different location.

    Args:
        auth: Authentication object containing Domo credentials.
        body: Request body with page IDs and target location.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the move operation response.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/bulk/move"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(message="PUT /content/v1/pages/bulk/move failed", res=res)
    return res

put_content_pages_pageid_analyzer async 

put_content_pages_pageid_analyzer(
    auth: DomoAuth,
    pageId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v3/pages/{pageId}/analyzer - Update analyzer settings for a page.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
pageId str

ID of the page whose analyzer settings are being updated.

 required
body dict[str, Any] | list[Any] | None

Request body with new analyzer configuration.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the updated analyzer settings.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def put_content_pages_pageid_analyzer(
    auth: DomoAuth,
    pageId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v3/pages/{pageId}/analyzer - Update analyzer settings for a page.

    Args:
        auth: Authentication object containing Domo credentials.
        pageId: ID of the page whose analyzer settings are being updated.
        body: Request body with new analyzer configuration.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the updated analyzer settings.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = (
        f"https://{auth.domo_instance}.domo.com/api/content/v3/pages/{pageId}/analyzer"
    )
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="PUT /content/v3/pages/{pageId}/analyzer failed", res=res
        )
    return res

put_content_pages_pageid_duplicate async 

put_content_pages_pageid_duplicate(
    auth: DomoAuth,
    pageId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/pages/{pageId}/duplicate - Duplicate a page (synchronous endpoint).

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
pageId str

ID of the page to duplicate.

 required
body dict[str, Any] | list[Any] | None

Request body with duplication parameters (e.g., new name).

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object with the API's response to the duplication request.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def put_content_pages_pageid_duplicate(
    auth: DomoAuth,
    pageId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/pages/{pageId}/duplicate - Duplicate a page (synchronous endpoint).

    Args:
        auth: Authentication object containing Domo credentials.
        pageId: ID of the page to duplicate.
        body: Request body with duplication parameters (e.g., new name).
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object with the API's response to the duplication request.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = (
        f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/{pageId}/duplicate"
    )
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="PUT /content/v1/pages/{pageId}/duplicate failed", res=res
        )
    return res

put_content_pages_pageid_duplicateasync async 

put_content_pages_pageid_duplicateasync(
    auth: DomoAuth,
    pageId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/pages/{pageId}/duplicateAsync - Duplicate a page (async endpoint).

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
pageId str

ID of the page to duplicate.

 required
body dict[str, Any] | list[Any] | None

Request body with duplication parameters (e.g., new name).

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object with the API's response to the duplication request.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def put_content_pages_pageid_duplicateasync(
    auth: DomoAuth,
    pageId: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/pages/{pageId}/duplicateAsync - Duplicate a page (async endpoint).

    Args:
        auth: Authentication object containing Domo credentials.
        pageId: ID of the page to duplicate.
        body: Request body with duplication parameters (e.g., new name).
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object with the API's response to the duplication request.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/{pageId}/duplicateAsync"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="PUT /content/v1/pages/{pageId}/duplicateAsync failed", res=res
        )
    return res

put_content_pages_pageorder async 

put_content_pages_pageorder(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/content/v1/pages/pageorder - Update the order of pages.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
body dict[str, Any] | list[Any] | None

Request body with page IDs in desired order.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the updated page order response.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def put_content_pages_pageorder(
    auth: DomoAuth,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/content/v1/pages/pageorder - Update the order of pages.

    Args:
        auth: Authentication object containing Domo credentials.
        body: Request body with page IDs in desired order.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the updated page order response.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/pages/pageorder"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(message="PUT /content/v1/pages/pageorder failed", res=res)
    return res

put_pages_page_id_collections_page_collection_id async 

put_pages_page_id_collections_page_collection_id(
    auth: DomoAuth,
    page_id: str,
    page_collection_id: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any
) -> ResponseGetData

PUT /api/v1/pages/{page_id}/collections/{page_collection_id} - Update page collection membership.

Updates the metadata or configuration for a page's membership in a collection.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing Domo credentials.

 required
page_id str

ID of the page whose collection membership is being updated.

 required
page_collection_id str

ID of the collection membership to update.

 required
body dict[str, Any] | list[Any] | None

Request body with updated collection membership parameters.

 None
context RouteContext | None

Optional RouteContext for API request configuration.

 None
**context_kwargs Any

Additional context parameters (session, debug_api, etc.).

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the updated collection membership information.

Raises:

Type Description
RouteError

If the API request fails.
Source code in src/crew_dcs/routes/page_gaps.py 
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
async def put_pages_page_id_collections_page_collection_id(
    auth: DomoAuth,
    page_id: str,
    page_collection_id: str,
    body: dict[str, Any] | list[Any] | None = None,
    *,
    context: RouteContext | None = None,
    **context_kwargs: Any,
) -> rgd.ResponseGetData:
    """PUT /api/v1/pages/{page_id}/collections/{page_collection_id} - Update page collection membership.

    Updates the metadata or configuration for a page's membership in a collection.

    Args:
        auth: Authentication object containing Domo credentials.
        page_id: ID of the page whose collection membership is being updated.
        page_collection_id: ID of the collection membership to update.
        body: Request body with updated collection membership parameters.
        context: Optional RouteContext for API request configuration.
        **context_kwargs: Additional context parameters (session, debug_api, etc.).

    Returns:
        ResponseGetData object containing the updated collection membership information.

    Raises:
        RouteError: If the API request fails.
    """
    context = RouteContext.build_context(context=context, **context_kwargs)
    url = f"https://{auth.domo_instance}.domo.com/api/v1/pages/{page_id}/collections/{page_collection_id}"
    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=body or {},
        context=context,
    )
    if not res.is_success:
        raise RouteError(
            message="PUT /v1/pages/{page_id}/collections/{page_collection_id} failed",
            res=res,
        )
    return res