Skip to content

Tags

This is a module containing: Monday query_tags* tasks

query_tags(monday_credentials, ids=None, return_fields=None) async

Get your data from monday.com.

Parameters:

Name Type Description Default
monday_credentials MondayCredentials

Credentials to use for authentication with Monday.

 required
ids Iterable[int]

A list of tags unique identifiers.

 None
return_fields Iterable[str]

Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.

 None

Returns:

Type Description
Dict[str, Any]

A dict of the returned fields.
Source code in prefect_monday/tags.py 
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
@task
async def query_tags(
    monday_credentials: MondayCredentials,
    ids: Iterable[int] = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:
    """
    Get your data from monday.com.

    Args:
        monday_credentials: Credentials to use for authentication with Monday.
        ids: A list of tags unique identifiers.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.tags(
        **strip_kwargs(
            ids=ids,
        )
    )

    op_stack = ("tags",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, monday_credentials)
    return result["tags"]