Skip to content

README.md

Latest commit

 

History

History
177 lines (128 loc) · 12.6 KB

README.md

File metadata and controls

177 lines (128 loc) · 12.6 KB

Reports.Executions

Overview

Available Operations

  • list - List executions for report
  • url - Create URL for executed report
  • get - Get executed report

list

List all executions of a specific report.

Example Usage

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH", ""),
) as g_client:

    res = g_client.reports.executions.list(report_id="4d4c7123-b794-4fad-b1b9-5ab2606e6bbe", limit=20)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description Example
report_id str ✔️ The ID of the report to retrieve details for. 4d4c7123-b794-4fad-b1b9-5ab2606e6bbe
cursor OptionalNullable[str] ➖ A pointer to the page of results to return. ZXhhbXBsZTE
limit Optional[int] ➖ The maximum number of items that are at returned. 20
merchant_account_id Optional[str] ➖ The ID of the merchant account to use for this request. default
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListReportExecutionsResponse

Errors

Error Type Status Code Content Type
errors.Error400 400 application/json
errors.Error401 401 application/json
errors.Error403 403 application/json
errors.Error404 404 application/json
errors.Error405 405 application/json
errors.Error409 409 application/json
errors.HTTPValidationError 422 application/json
errors.Error425 425 application/json
errors.Error429 429 application/json
errors.Error500 500 application/json
errors.Error502 502 application/json
errors.Error504 504 application/json
errors.APIError 4XX, 5XX */*

url

Creates a download URL for a specific execution of a report.

Example Usage

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH", ""),
) as g_client:

    res = g_client.reports.executions.url(report_id="4d4c7123-b794-4fad-b1b9-5ab2606e6bbe", report_execution_id="003bc416-f32a-420c-8eb2-062a386e1fb0", expires_in=5)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
report_id str ✔️ The ID of the report to retrieve a URL for. 4d4c7123-b794-4fad-b1b9-5ab2606e6bbe
report_execution_id str ✔️ The ID of the execution of a report to retrieve a URL for. 003bc416-f32a-420c-8eb2-062a386e1fb0
merchant_account_id Optional[str] ➖ The ID of the merchant account to use for this request. default
expires_in Optional[int] ➖ The URL expiration time, in minutes. 5
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ReportExecutionURL

Errors

Error Type Status Code Content Type
errors.Error400 400 application/json
errors.Error401 401 application/json
errors.Error403 403 application/json
errors.Error404 404 application/json
errors.Error405 405 application/json
errors.Error409 409 application/json
errors.HTTPValidationError 422 application/json
errors.Error425 425 application/json
errors.Error429 429 application/json
errors.Error500 500 application/json
errors.Error502 502 application/json
errors.Error504 504 application/json
errors.APIError 4XX, 5XX */*

get

Fetch a specific executed report.

Example Usage

from gr4vy import Gr4vy
import os


with Gr4vy(
    merchant_account_id="default",
    bearer_auth=os.getenv("GR4VY_BEARER_AUTH", ""),
) as g_client:

    res = g_client.reports.executions.get(report_execution_id="003bc416-f32a-420c-8eb2-062a386e1fb0")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
report_execution_id str ✔️ The ID of the execution of a report to retrieve details for. 003bc416-f32a-420c-8eb2-062a386e1fb0
merchant_account_id Optional[str] ➖ The ID of the merchant account to use for this request. default
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ReportExecution

Errors

Error Type Status Code Content Type
errors.Error400 400 application/json
errors.Error401 401 application/json
errors.Error403 403 application/json
errors.Error404 404 application/json
errors.Error405 405 application/json
errors.Error409 409 application/json
errors.HTTPValidationError 422 application/json
errors.Error425 425 application/json
errors.Error429 429 application/json
errors.Error500 500 application/json
errors.Error502 502 application/json
errors.Error504 504 application/json
errors.APIError 4XX, 5XX */*