Skip to content

JobsApi.md

Latest commit

 

History

History
268 lines (186 loc) · 10.1 KB

JobsApi.md

File metadata and controls

268 lines (186 loc) · 10.1 KB

wordlift_client.JobsApi

All URIs are relative to https://api.wordlift.io

Method HTTP request Description
create_job_kpi_graphs_graph_id_jobs_post POST /kpi/graphs/{graph_id}/jobs Submit a KPI job
get_job_kpi_graphs_graph_id_jobs_job_id_get GET /kpi/graphs/{graph_id}/jobs/{job_id} Get job status
list_jobs_for_graph_kpi_graphs_graph_id_jobs_get GET /kpi/graphs/{graph_id}/jobs List jobs for a graph

create_job_kpi_graphs_graph_id_jobs_post

JobResponse create_job_kpi_graphs_graph_id_jobs_post(graph_id, submit_job_body)

Submit a KPI job

Creates or reuses a KPI calculation job for the requested graph and snapshot day. When the latest source watermark, worker major.minor version, and validation-policy fingerprint match the newest validated snapshot, the service completes the request immediately by cloning that snapshot instead of running the worker. Set force_rerun=true to bypass reuse and require a fresh worker run.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.job_response import JobResponse
from wordlift_client.models.submit_job_body import SubmitJobBody
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.JobsApi(api_client)
    graph_id = '1506805' # str | Public WordLift graph identifier (`account.id`).
    submit_job_body = wordlift_client.SubmitJobBody() # SubmitJobBody | 

    try:
        # Submit a KPI job
        api_response = await api_instance.create_job_kpi_graphs_graph_id_jobs_post(graph_id, submit_job_body)
        print("The response of JobsApi->create_job_kpi_graphs_graph_id_jobs_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobsApi->create_job_kpi_graphs_graph_id_jobs_post: %s\n" % e)

Parameters

Name Type Description Notes
graph_id str Public WordLift graph identifier (`account.id`).
submit_job_body SubmitJobBody

Return type

JobResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/problem+json

HTTP response details

Status code Description Response headers
202 Job accepted or existing reusable job returned. -
400 The request was syntactically valid but semantically invalid. -
403 The caller is not authorized to operate on the requested graph. -
404 The requested resource was not found. -
409 The request conflicts with current job state or freshness rules. -
422 Validation Error -

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

get_job_kpi_graphs_graph_id_jobs_job_id_get

JobResponse get_job_kpi_graphs_graph_id_jobs_job_id_get(graph_id, job_id)

Get job status

Returns the current persisted job state, including operational timestamps, stage, heartbeat, counters, and stage timings.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.job_response import JobResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.JobsApi(api_client)
    graph_id = '1506805' # str | Public WordLift graph identifier (`account.id`).
    job_id = 'job_20260313_5bdaac21' # str | Unique job identifier.

    try:
        # Get job status
        api_response = await api_instance.get_job_kpi_graphs_graph_id_jobs_job_id_get(graph_id, job_id)
        print("The response of JobsApi->get_job_kpi_graphs_graph_id_jobs_job_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobsApi->get_job_kpi_graphs_graph_id_jobs_job_id_get: %s\n" % e)

Parameters

Name Type Description Notes
graph_id str Public WordLift graph identifier (`account.id`).
job_id str Unique job identifier.

Return type

JobResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

HTTP response details

Status code Description Response headers
200 Job status. -
403 The caller is not authorized to operate on the requested graph. -
404 The requested resource was not found. -
422 Validation Error -

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

list_jobs_for_graph_kpi_graphs_graph_id_jobs_get

JobListResponse list_jobs_for_graph_kpi_graphs_graph_id_jobs_get(graph_id, limit=limit, cursor=cursor)

List jobs for a graph

Returns persisted jobs for one graph ordered by most recently updated first. Use the opaque cursor token from a previous page to continue pagination.

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.job_list_response import JobListResponse
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.JobsApi(api_client)
    graph_id = '1506805' # str | Public WordLift graph identifier (`account.id`).
    limit = 56 # int | Maximum number of jobs to return. (optional)
    cursor = 'cursor_example' # str | Opaque cursor returned by a previous page. (optional)

    try:
        # List jobs for a graph
        api_response = await api_instance.list_jobs_for_graph_kpi_graphs_graph_id_jobs_get(graph_id, limit=limit, cursor=cursor)
        print("The response of JobsApi->list_jobs_for_graph_kpi_graphs_graph_id_jobs_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling JobsApi->list_jobs_for_graph_kpi_graphs_graph_id_jobs_get: %s\n" % e)

Parameters

Name Type Description Notes
graph_id str Public WordLift graph identifier (`account.id`).
limit int Maximum number of jobs to return. [optional]
cursor str Opaque cursor returned by a previous page. [optional]

Return type

JobListResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

HTTP response details

Status code Description Response headers
200 Graph-specific jobs ordered descending by recency. -
403 The caller is not authorized to operate on the requested graph. -
404 The requested resource was not found. -
422 Validation Error -

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