Skip to content

core

core

get_events async 

get_events(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List objective events.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing objective events

Raises:

Type Description
Objectives_GET_Error

If event retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_events(
    auth: DomoAuth,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List objective events.

    Args:
        auth: Authentication object for API requests
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing objective events

    Raises:
        Objectives_GET_Error: If event retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/events"

    res = await gd.get_data(auth=auth, url=url, method="GET", context=context)

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_objective_drafts async 

get_objective_drafts(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List objective drafts.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
filter_key_results bool

Whether to filter out key results from the response

 False
period_id int | None

Optional period ID to filter objective drafts by

 None
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing objective drafts

Raises:

Type Description
Objectives_GET_Error

If draft retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_objective_drafts(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List objective drafts.

    Args:
        auth: Authentication object for API requests
        filter_key_results: Whether to filter out key results from the response
        period_id: Optional period ID to filter objective drafts by
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing objective drafts

    Raises:
        Objectives_GET_Error: If draft retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v2/objectives/draft"
    params = {"filterKeyResults": filter_key_results}
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_objectives async 

get_objectives(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Search objectives.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
filter_key_results bool

Whether to filter out key results from the response

 False
period_id int | None

Optional period ID to filter objectives by

 None
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing matching objectives

Raises:

Type Description
Objectives_GET_Error

If objective search fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_objectives(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Search objectives.

    Args:
        auth: Authentication object for API requests
        filter_key_results: Whether to filter out key results from the response
        period_id: Optional period ID to filter objectives by
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing matching objectives

    Raises:
        Objectives_GET_Error: If objective search fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/search"
    params = {"filterKeyResults": filter_key_results}
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_objectives_needing_update async 

get_objectives_needing_update(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List objectives that need an update.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
filter_key_results bool

Whether to filter out key results from the response

 False
period_id int | None

Optional period ID to filter objectives by

 None
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing objectives needing an update

Raises:

Type Description
Objectives_GET_Error

If objective retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_objectives_needing_update(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List objectives that need an update.

    Args:
        auth: Authentication object for API requests
        filter_key_results: Whether to filter out key results from the response
        period_id: Optional period ID to filter objectives by
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing objectives needing an update

    Raises:
        Objectives_GET_Error: If objective retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/needs-update"
    params = {"filterKeyResults": filter_key_results}
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_objectives_report async 

get_objectives_report(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    type: str = "COMPANY",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Get an objectives report (e.g. the company objectives report).

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
filter_key_results bool

Whether to filter out key results from the response

 False
period_id int | None

Optional period ID to filter the report by

 None
type str

Report scope type (e.g. "COMPANY", "PERSONAL", "TEAM")

 'COMPANY'
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing the objectives report

Raises:

Type Description
Objectives_GET_Error

If report retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_objectives_report(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    type: str = "COMPANY",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """Get an objectives report (e.g. the company objectives report).

    Args:
        auth: Authentication object for API requests
        filter_key_results: Whether to filter out key results from the response
        period_id: Optional period ID to filter the report by
        type: Report scope type (e.g. "COMPANY", "PERSONAL", "TEAM")
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing the objectives report

    Raises:
        Objectives_GET_Error: If report retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v2/objectives/report"
    params = {"filterKeyResults": filter_key_results, "type": type}
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_periods async 

get_periods(
    auth: DomoAuth,
    all: bool = True,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List objective periods.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
all bool

Whether to return all periods

 True
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing objective periods

Raises:

Type Description
Objectives_GET_Error

If period retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_periods(
    auth: DomoAuth,
    all: bool = True,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List objective periods.

    Args:
        auth: Authentication object for API requests
        all: Whether to return all periods
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing objective periods

    Raises:
        Objectives_GET_Error: If period retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v1/objectives/periods"
    params = {"all": all}

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_personal_objectives async 

get_personal_objectives(
    auth: DomoAuth,
    filter_key_results: bool = False,
    include_sample_goal: bool = False,
    period_id: int | None = None,
    type: str = "PERSONAL",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List objectives for the current user's profile.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
filter_key_results bool

Whether to filter out key results from the response

 False
include_sample_goal bool

Whether to include Domo's sample goal in the response

 False
period_id int | None

Optional period ID to filter objectives by

 None
type str

Objective type to filter by (e.g. "PERSONAL")

 'PERSONAL'
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing personal objectives

Raises:

Type Description
Objectives_GET_Error

If objective retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
 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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_personal_objectives(
    auth: DomoAuth,
    filter_key_results: bool = False,
    include_sample_goal: bool = False,
    period_id: int | None = None,
    type: str = "PERSONAL",
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List objectives for the current user's profile.

    Args:
        auth: Authentication object for API requests
        filter_key_results: Whether to filter out key results from the response
        include_sample_goal: Whether to include Domo's sample goal in the response
        period_id: Optional period ID to filter objectives by
        type: Objective type to filter by (e.g. "PERSONAL")
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing personal objectives

    Raises:
        Objectives_GET_Error: If objective retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/social/v2/objectives/profile"
    params = {
        "filterKeyResults": filter_key_results,
        "includeSampleGoal": include_sample_goal,
        "type": type,
    }
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res

get_team_objectives async 

get_team_objectives(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

List objectives for teams.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object for API requests

 required
filter_key_results bool

Whether to filter out key results from the response

 False
period_id int | None

Optional period ID to filter objectives by

 None
return_raw bool

Return raw response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None

Returns:

Type Description
ResponseGetData

ResponseGetData object containing team objectives

Raises:

Type Description
Objectives_GET_Error

If objective retrieval fails
Source code in src/crew_dcs/routes/objectives/core.py 
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
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(result_processor=ResponseGetDataProcessor()),
)
async def get_team_objectives(
    auth: DomoAuth,
    filter_key_results: bool = False,
    period_id: int | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """List objectives for teams.

    Args:
        auth: Authentication object for API requests
        filter_key_results: Whether to filter out key results from the response
        period_id: Optional period ID to filter objectives by
        return_raw: Return raw response without processing
        context: RouteContext for request configuration

    Returns:
        ResponseGetData object containing team objectives

    Raises:
        Objectives_GET_Error: If objective retrieval fails
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = (
        f"https://{auth.domo_instance}.domo.com/api/social/v2/objectives/teams-profile"
    )
    params = {"filterKeyResults": filter_key_results}
    if period_id is not None:
        params["periodId"] = period_id

    res = await gd.get_data(
        auth=auth, url=url, method="GET", params=params, context=context
    )

    if return_raw:
        return res
    if not res.is_success:
        raise Objectives_GET_Error(res=res)
    return res