organization_data_campaigns_api module#

class edgeimpulse_api.api.organization_data_campaigns_api.OrganizationDataCampaignsApi(api_client=None)[source]#

Bases: object

add_organization_data_campaign(
organization_id: StrictInt[StrictInt],
add_organization_data_campaign_request: AddOrganizationDataCampaignRequest,
**kwargs,
) → AddOrganizationDataCampaignResponse[source]#

Add a data campaign

Add a new data campaign to a data campaign dashboard

Parameters:

  • organization_id (int) – Organization ID (required)

  • add_organization_data_campaign_request (AddOrganizationDataCampaignRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AddOrganizationDataCampaignResponse

add_organization_data_campaign_dashboard(
organization_id: StrictInt[StrictInt],
add_organization_data_campaign_dashboard_request: AddOrganizationDataCampaignDashboardRequest,
**kwargs,
) → AddOrganizationDataCampaignDashboardResponse[source]#

Add data campaign dashboard

Add a new data campaign dashboard

Parameters:

  • organization_id (int) – Organization ID (required)

  • add_organization_data_campaign_dashboard_request (AddOrganizationDataCampaignDashboardRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

AddOrganizationDataCampaignDashboardResponse

delete_organization_data_campaign(
organization_id: StrictInt[StrictInt],
campaign_id: StrictInt,
**kwargs,
) → GenericApiResponse[source]#

Delete data campaign

Delete a data campaign

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_id (int) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

delete_organization_data_campaign_dashboard(
organization_id: StrictInt[StrictInt],
campaign_dashboard_id: StrictInt,
**kwargs,
) → GenericApiResponse[source]#

Delete data campaign dashboard

Delete a data campaign dashboard

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_dashboard_id (int) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

get_organization_data_campaign(
organization_id: StrictInt[StrictInt],
campaign_id: StrictInt,
**kwargs,
) → GetOrganizationDataCampaignResponse[source]#

Get data campaign

Get a data campaign

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_id (int) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetOrganizationDataCampaignResponse

get_organization_data_campaign_dashboard(
organization_id: StrictInt[StrictInt],
campaign_dashboard_id: StrictInt,
**kwargs,
) → GetOrganizationDataCampaignDashboardResponse[source]#

Get data campaign dashboard

Get a data campaign dashboard

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_dashboard_id (int) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetOrganizationDataCampaignDashboardResponse

get_organization_data_campaign_dashboards(
organization_id: StrictInt[StrictInt],
**kwargs,
) → GetOrganizationDataCampaignDashboardsResponse[source]#

Get data campaign dashboards

List all data campaign dashboards

Parameters:

  • organization_id (int) – Organization ID (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetOrganizationDataCampaignDashboardsResponse

get_organization_data_campaign_diff(
organization_id: StrictInt[StrictInt],
campaign_id: StrictInt,
organization_data_campaign_diff_request: OrganizationDataCampaignDiffRequest,
**kwargs,
) → OrganizationDataCampaignDiffResponse[source]#

Get diff for data campaign

Get which items have changed for a data campaign. You post the data points and we’ll return which data items are different in the past day.

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_id (int) – (required)

  • organization_data_campaign_diff_request (OrganizationDataCampaignDiffRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

OrganizationDataCampaignDiffResponse

get_organization_data_campaigns_for_dashboard(
organization_id: StrictInt[StrictInt],
campaign_dashboard_id: StrictInt,
**kwargs,
) → GetOrganizationDataCampaignsResponse[source]#

Get data campaigns

Get a list of all data campaigns for a dashboard

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_dashboard_id (int) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GetOrganizationDataCampaignsResponse

update_organization_data_campaign(
organization_id: StrictInt[StrictInt],
campaign_id: StrictInt,
update_organization_data_campaign_request: UpdateOrganizationDataCampaignRequest,
**kwargs,
) → GenericApiResponse[source]#

Update data campaign

Update a data campaign

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_id (int) – (required)

  • update_organization_data_campaign_request (UpdateOrganizationDataCampaignRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

update_organization_data_campaign_dashboard(
organization_id: StrictInt[StrictInt],
campaign_dashboard_id: StrictInt,
update_organization_data_campaign_dashboard_request: UpdateOrganizationDataCampaignDashboardRequest,
**kwargs,
) → GenericApiResponse[source]#

Update data campaign dashboard

Update a data campaign dashboard

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_dashboard_id (int) – (required)

  • update_organization_data_campaign_dashboard_request (UpdateOrganizationDataCampaignDashboardRequest) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse

upload_dashboard_screenshot(
organization_id: StrictInt[StrictInt],
campaign_dashboard_id: StrictInt,
image: StrictStr,
**kwargs,
) → GenericApiResponse[source]#

Upload a dashboard screenshot

Used internally to upload a picture of a screenshot

Parameters:

  • organization_id (int) – Organization ID (required)

  • campaign_dashboard_id (int) – (required)

  • image (str) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

GenericApiResponse