scheduled_reports

scheduled_reports

send_report_now_by_schedule_id async

send_report_now_by_schedule_id(
    auth: DomoAuth,
    schedule_id: str,
    recipients: list[dict],
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Trigger an immediate send of a Report Builder distribution by schedule ID.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Domo authentication object	required
schedule_id	str	The ID of the report schedule to trigger	required
recipients	list[dict]	List of recipient dicts, e.g. [{"type": "EMAIL", "value": "user@example.com"}]	required
context	RouteContext | None	Optional RouteContext	None

Returns:

Type	Description
ResponseGetData	ResponseGetData — 202 Accepted on success

Raises:

Type	Description
ReportSchedule_SEND_Error	If the send operation fails

Source code in src/crew_dcs/routes/scheduled_reports.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def send_report_now_by_schedule_id(
    auth: DomoAuth,
    schedule_id: str,
    recipients: list[dict],
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Trigger an immediate send of a Report Builder distribution by schedule ID.

    Args:
        auth: Domo authentication object
        schedule_id: The ID of the report schedule to trigger
        recipients: List of recipient dicts, e.g. [{"type": "EMAIL", "value": "user@example.com"}]
        context: Optional RouteContext

    Returns:
        ResponseGetData — 202 Accepted on success

    Raises:
        ReportSchedule_SEND_Error: If the send operation fails
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/reportschedules/{schedule_id}/sendnow"
    res = await gd.get_data(
        auth=auth,
        method="POST",
        url=url,
        body=recipients,
        context=context,
    )

    if not res.is_success:
        raise ReportSchedule_SEND_Error(entity_id=schedule_id, res=res)

    return res

send_report_now_by_view_id async

send_report_now_by_view_id(
    auth: DomoAuth,
    view_id: str,
    recipients: list[dict],
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Trigger an immediate send of a Report Builder distribution by view ID.

Parameters:

Name	Type	Description	Default
auth	DomoAuth	Domo authentication object	required
view_id	str	The Report Builder view ID to trigger	required
recipients	list[dict]	List of recipient dicts, e.g. [{"type": "EMAIL", "value": "user@example.com"}]	required
context	RouteContext | None	Optional RouteContext	None

Returns:

Type	Description
ResponseGetData	ResponseGetData — 202 Accepted on success

Raises:

Type	Description
ReportSchedule_SEND_Error	If the send operation fails

Source code in src/crew_dcs/routes/scheduled_reports.py

@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def send_report_now_by_view_id(
    auth: DomoAuth,
    view_id: str,
    recipients: list[dict],
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Trigger an immediate send of a Report Builder distribution by view ID.

    Args:
        auth: Domo authentication object
        view_id: The Report Builder view ID to trigger
        recipients: List of recipient dicts, e.g. [{"type": "EMAIL", "value": "user@example.com"}]
        context: Optional RouteContext

    Returns:
        ResponseGetData — 202 Accepted on success

    Raises:
        ReportSchedule_SEND_Error: If the send operation fails
    """
    url = f"https://{auth.domo_instance}.domo.com/api/content/v1/reportschedules/views/{view_id}/sendNow"
    res = await gd.get_data(
        auth=auth,
        method="POST",
        url=url,
        body=recipients,
        context=context,
    )

    if not res.is_success:
        raise ReportSchedule_SEND_Error(entity_id=view_id, res=res)

    return res