Skip to content
OpenGTM

Create Workbook From Jobs

POST
/api/workbooks/from-jobs
curl --request POST \
  --url http://localhost:8000/api/workbooks/from-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "job_ids": [ "example" ], "name": "example", "workbook_id": "example" }'

Create a workbook from job results, or merge new jobs into an existing workbook.

The workbook filter_criteria uses job_ids to show leads from those specific jobs. If workbook_id is provided, the new job IDs are merged into the existing workbook’s filter.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateFromJobsRequest

Create or merge a workbook from one or more collection jobs.

object
job_ids
required
Job Ids

Job IDs to include

Array<string>
>= 1 items
name
Any of:
string
workbook_id
Any of:
string
Examplegenerated
{
  "job_ids": [
    "example"
  ],
  "name": "example",
  "workbook_id": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkbookResponse

Workbook response — returned from API.

object
columns_config
required
Columns Config
Array<object>
object
key
additional properties
any
completed_rows
required
Completed Rows
integer
created_at
Any of:
string format: date-time
description
required
Description
string
filter_criteria
Any of:
object
key
additional properties
any
id
required
Id
string
last_run_at
Any of:
string format: date-time
name
required
Name
string
source_config
Any of:
object
key
additional properties
any
source_type
Source Type
string
default: empty
status
required
Status
string
sync_to_leads
Sync To Leads
boolean
default: true
total_rows
required
Total Rows
integer
updated_at
Any of:
string format: date-time
Example
{
  "source_type": "empty",
  "sync_to_leads": true
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}