RawExportApi.md

gooddata_api_client.RawExportApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_raw_export	POST /api/v1/actions/workspaces/{workspaceId}/export/raw	(EXPERIMENTAL) Create raw export request
get_raw_export	GET /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}	(EXPERIMENTAL) Retrieve exported files

create_raw_export

ExportResponse create_raw_export(workspace_id, raw_export_request)

(EXPERIMENTAL) Create raw export request

Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import raw_export_api
from gooddata_api_client.model.export_response import ExportResponse
from gooddata_api_client.model.raw_export_request import RawExportRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = raw_export_api.RawExportApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    raw_export_request = RawExportRequest(
        custom_override=RawCustomOverride(
            labels={
                "key": RawCustomLabel(
                    title="title_example",
                ),
            },
            metrics={
                "key": RawCustomMetric(
                    title="title_example",
                ),
            },
        ),
        execution=AFM(
            attributes=[
                AttributeItem(
                    label=AfmObjectIdentifierLabel(
                        identifier=AfmObjectIdentifierLabelIdentifier(
                            id="sample_item.price",
                            type="label",
                        ),
                    ),
                    local_identifier="attribute_1",
                    show_all_values=False,
                ),
            ],
            aux_measures=[
                MeasureItem(
                    definition=MeasureDefinition(),
                    local_identifier="metric_1",
                ),
            ],
            filters=[
                FilterDefinition(),
            ],
            measures=[
                MeasureItem(
                    definition=MeasureDefinition(),
                    local_identifier="metric_1",
                ),
            ],
        ),
        execution_settings=ExecutionSettings(
            data_sampling_percentage=0,
            timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'),
        ),
        file_name="result",
        format="CSV",
    ) # RawExportRequest | 

    # example passing only required values which don't have defaults set
    try:
        # (EXPERIMENTAL) Create raw export request
        api_response = api_instance.create_raw_export(workspace_id, raw_export_request)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling RawExportApi->create_raw_export: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
raw_export_request	RawExportRequest

Return type

ExportResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Raw export request created successfully.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_raw_export

get_raw_export(workspace_id, export_id)

(EXPERIMENTAL) Retrieve exported files

Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.

Example

import time
import gooddata_api_client
from gooddata_api_client.api import raw_export_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = raw_export_api.RawExportApi(api_client)
    workspace_id = "workspaceId_example" # str | 
    export_id = "exportId_example" # str | 

    # example passing only required values which don't have defaults set
    try:
        # (EXPERIMENTAL) Retrieve exported files
        api_instance.get_raw_export(workspace_id, export_id)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling RawExportApi->get_raw_export: %s\n" % e)

Parameters

Name	Type	Description	Notes
workspace_id	str
export_id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream, text/csv

HTTP response details

Status code	Description	Response headers
200	Binary export result.	* Content-Disposition -
202	Request is accepted, provided exportId exists, but export is not yet ready.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]