`agency`

Open an operation to see its authentication, its parameters and the fields of its request and response.

11 operations

GET`/v1/agency/clients/{id}`

One client: its card, service levels, report settings and consent.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/agency/clients/{id}
Name	Type	Description
`id`pathrequired	`string`
`period`query	`string`

Response `200`

Response, GET /v1/agency/clients/{id}
Name	Type	Description
`card`required	`object`
`card.workspace_id`required	`string`
`card.workspace_name`required	`string`
`card.client_name`required	`string`
`card.slug`required	`string`
`card.open_tickets`required	`integer`
`card.awaiting_approval`required	`integer`
`card.escalations`required	`integer`
`card.sla_breached`required	`integer`
`card.tickets_received`required	`integer`
`card.tickets_resolved`required	`integer`
`card.median_first_response_minutes`required	`number`
`card.median_release_minutes`required	`number`
`card.proactive_fixes`required	`integer`
`card.last_release`required	`object`
`card.last_release.id`required	`string`
`card.last_release.version`required	`string`
`card.last_release.tag`required	`string`
`card.last_release.released_at`required	`string (date-time)`
`card.sla`required	`object`
`card.sla.first_response_minutes`required	`integer`
`card.sla.resolution_minutes`required	`integer`
`card.resale_price`required	`number`
`card.white_label_missing`required	`array of enum`
`settings`required	`object`
`settings.sla`required	`object`
`settings.sla.first_response_minutes`required	`integer`
`settings.sla.resolution_minutes`required	`integer`
`settings.report_recipients`required	`array of string (email)`
`settings.report_intro`required	`string`
`settings.report_auto_send`required	`boolean`
`settings.patterns_opt_in`required	`boolean`
`settings.organization_patterns_opt_in`required	`boolean`
`settings.locale`required	`enum`	Values `en \| it`
`settings.brand_profile_id`required	`string`
`settings.resale_price`required	`number`
`settings.collect_via_connect`required	`boolean`
`settings.managed_addon`required	`boolean`
`status_base_url`required	`string (uri)`
`brand_name`required	`string`

GET`/v1/agency/overview`

One card per client: open tickets, approvals, escalations, medians, releases.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/agency/overview
Name	Type	Description
`period`query	`string`

Response `200`

Response, GET /v1/agency/overview
Name	Type	Description
`period`required	`string`
`clients`required	`array of object`
`clients[].workspace_id`required	`string`
`clients[].workspace_name`required	`string`
`clients[].client_name`required	`string`
`clients[].slug`required	`string`
`clients[].open_tickets`required	`integer`
`clients[].awaiting_approval`required	`integer`
`clients[].escalations`required	`integer`
`clients[].sla_breached`required	`integer`
`clients[].tickets_received`required	`integer`
`clients[].tickets_resolved`required	`integer`
`clients[].median_first_response_minutes`required	`number`
`clients[].median_release_minutes`required	`number`
`clients[].proactive_fixes`required	`integer`
`clients[].last_release`required	`object`
`clients[].last_release.id`required	`string`
`clients[].last_release.version`required	`string`
`clients[].last_release.tag`required	`string`
`clients[].last_release.released_at`required	`string (date-time)`
`clients[].sla`required	`object`
`clients[].sla.first_response_minutes`required	`integer`
`clients[].sla.resolution_minutes`required	`integer`
`clients[].resale_price`required	`number`
`clients[].white_label_missing`required	`array of enum`
`totals`required	`object`
`totals.clients`required	`integer`
`totals.open_tickets`required	`integer`
`totals.awaiting_approval`required	`integer`
`totals.escalations`required	`integer`
`totals.sla_breached`required	`integer`
`totals.tickets_received`required	`integer`
`totals.tickets_resolved`required	`integer`
`totals.proactive_fixes`required	`integer`
`totals.median_first_response_minutes`required	`number`
`totals.median_release_minutes`required	`number`

GET`/v1/agency/partner`

The agency partner profile, certification and referred customers.

Authentication: Dashboard session

Response `200`

Response, GET /v1/agency/partner
Name	Type	Description
`status`required	`enum`	Values `none \| pending \| certified`
`profile`required	`object`
`profile.id`required	`string`
`profile.public_name`required	`string`
`profile.website_url`required	`string (uri)`
`profile.description`required	`string`
`profile.country`required	`string`
`profile.logo_url`required	`string (uri)`
`profile.certified_at`required	`string (date-time)`
`profile.listed`required	`boolean`
`profile.commission_rate`required	`number`
`profile.review_requested_at`required	`string (date-time)`
`profile.created_at`required	`string (date-time)`
`referral_code`required	`string`
`referred_customers`required	`integer`

PUT`/v1/agency/partner`

Creates or changes the public partner profile; certification is decided by staff.

Authentication: Dashboard session

Request body

Request body, PUT /v1/agency/partner
Name	Type	Description
`public_name`required	`string`
`website_url`required	`string`
`description`required	`string`
`country`required	`string`
`logo_url`required	`string`

Response `200`

The same fields as GET /v1/agency/partner.

GET`/v1/agency/queue`

Approvals and escalations of every client in one queue, with the SLA timers.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/agency/queue
Name	Type	Description
`cursor`query	`string`
`limit`query	`integer`
`client`query	`array of string`
`kind`query	`array of enum`
`sla`query	`array of enum`
`min_age_minutes`query	`integer`
`max_age_minutes`query	`integer`
`sort`query	`enum`	Values `urgency \| oldest \| newest`

Response `200`

Response, GET /v1/agency/queue
Name	Type	Description
`items`required	`array of object`
`items[].kind`required	`enum`	Values `draft \| fix \| escalation`
`items[].ticket`required	`object`
`items[].ticket.id`required	`string`
`items[].ticket.org_id`required	`string`
`items[].ticket.workspace_id`required	`string`
`items[].ticket.workspace_name`required	`string`
`items[].ticket.client_name`required	`string`
`items[].ticket.channel_id`required	`string`
`items[].ticket.origin`required	`enum`	Values `email \| widget \| github \| proactive`
`items[].ticket.external_id`required	`string`
`items[].ticket.customer_email`required	`string`
`items[].ticket.customer_name`required	`string`
`items[].ticket.subject`required	`string`
`items[].ticket.state`required	`enum`	Values `received \| triage \| needs_info \| draft_ready \| answered \| fixing \| awaiting_approval \| releasing \| customer_notified \| closed \| escalated`
`items[].ticket.public_state`required	`enum`	Values `in_analysis \| needs_reply \| answered \| fix_in_progress \| releasing \| resolved \| team_review`
`items[].ticket.category`required	`enum`	Values `usage \| config \| docs \| bug \| feature_request \| unknown`
`items[].ticket.priority`required	`enum`	Values `low \| normal \| high \| urgent`
`items[].ticket.assignee_user_id`required	`string`
`items[].ticket.github_item_kind`required	`enum`	Values `issue \| pull_request`
`items[].ticket.github_number`required	`integer`
`items[].ticket.labels`required	`array of string`
`items[].ticket.language`required	`string`
`items[].ticket.is_demo`required	`boolean`
`items[].ticket.demo`required	`boolean`
`items[].ticket.error_group_id`required	`string`
`items[].ticket.duplicate_of_ticket_id`required	`string`
`items[].ticket.resolved_version`required	`string`
`items[].ticket.latest_confidence`required	`number`
`items[].ticket.needs_team_action`required	`boolean`
`items[].ticket.message_count`required	`integer`
`items[].ticket.last_message_at`required	`string (date-time)`
`items[].ticket.first_response_at`required	`string (date-time)`
`items[].ticket.released_at`required	`string (date-time)`
`items[].ticket.closed_at`required	`string (date-time)`
`items[].ticket.last_customer_message_at`required	`string (date-time)`
`items[].ticket.sla_due_at`required	`string (date-time)`
`items[].ticket.reopened_count`required	`integer`
`items[].ticket.created_at`required	`string (date-time)`
`items[].ticket.updated_at`required	`string (date-time)`
`items[].waiting_since`required	`string (date-time)`
`items[].waiting_minutes`required	`integer`
`items[].summary`required	`string`
`items[].fix`required	`object`
`items[].fix.id`required	`string`
`items[].fix.attempt_number`required	`integer`
`items[].fix.pr_number`required	`integer`
`items[].fix.pr_url`required	`string (uri)`
`items[].fix.head_sha`required	`string`
`items[].fix.status`required	`enum`	Values `prepared \| proposed`
`items[].fix.verified_by`required	`enum`	Values `harness \| agent \| server`
`items[].fix.tests_passed`required	`boolean`
`items[].fix.diff_stats`required	`object`
`items[].fix.diff_stats.files_changed`required	`integer`
`items[].fix.diff_stats.additions`required	`integer`
`items[].fix.diff_stats.deletions`required	`integer`
`items[].sla`required	`object`
`items[].sla.first_response`required	`object`
`items[].sla.first_response.due_at`required	`string (date-time)`
`items[].sla.first_response.status`required	`enum`	Values `none \| pending \| breached \| met \| missed`
`items[].sla.first_response.remaining_minutes`required	`integer`
`items[].sla.resolution`required	`object`
`items[].sla.resolution.due_at`required	`string (date-time)`
`items[].sla.resolution.status`required	`enum`	Values `none \| pending \| breached \| met \| missed`
`items[].sla.resolution.remaining_minutes`required	`integer`
`items[].sla.breached`required	`boolean`
`items[].sla.due_soon`required	`boolean`
`items[].sla.next_due_at`required	`string (date-time)`
`next_cursor`required	`string`
`releases`required	`array of object`
`releases[].id`required	`string`
`releases[].org_id`required	`string`
`releases[].workspace_id`required	`string`
`releases[].repository_id`required	`string`
`releases[].tag`required	`string`
`releases[].version`required	`string`
`releases[].sha`required	`string`
`releases[].merged_sha`required	`string`
`releases[].status`required	`enum`	Values `proposed \| approved \| merging \| tagged \| ci_running \| succeeded \| failed`
`releases[].ci_status`required	`enum`	Values `pending \| running \| success \| failure \| none`

GET`/v1/agency/reports`

Monthly client reports, newest month first (clients see their own).

Authentication: Dashboard session

Parameters

Parameters, GET /v1/agency/reports
Name	Type	Description
`cursor`query	`string`
`limit`query	`integer`
`workspace_id`query	`string`
`period`query	`string`

Response `200`

Response, GET /v1/agency/reports
Name	Type	Description
`items`required	`array of object`
`items[].id`required	`string`
`items[].workspace_id`required	`string`
`items[].workspace_name`required	`string`
`items[].client_name`required	`string`
`items[].period`required	`string`
`items[].status`required	`enum`	Values `draft \| generated \| sent \| failed`
`items[].metrics`required	`object`
`items[].metrics.tickets_received`required	`integer`
`items[].metrics.tickets_resolved`required	`integer`
`items[].metrics.median_first_response_minutes`required	`number`
`items[].metrics.median_release_minutes`required	`number`
`items[].metrics.releases`required	`integer`
`items[].metrics.proactive_fixes`required	`integer`
`items[].metrics.top_modules`required	`array of object`
`items[].metrics.top_modules[].module`required	`string`
`items[].metrics.top_modules[].tickets`required	`integer`
`items[].metrics.by_category`required	`object`
`items[].intro_md`required	`string`
`items[].sent_to`required	`array of string (email)`
`items[].sent_at`required	`string (date-time)`
`items[].generated_at`required	`string (date-time)`
`items[].created_at`required	`string (date-time)`
`items[].pdf_path`required	`string`
`next_cursor`required	`string`
`latest_period`required	`string`

POST`/v1/agency/reports`

Generates the report of a client for a month (idempotent per month).

Authentication: Dashboard session

Request body

Request body, POST /v1/agency/reports
Name	Type	Description
`workspace_id`required	`string`
`period`required	`string`
`regenerate`	`boolean`

Response `201`

Response, POST /v1/agency/reports
Name	Type	Description
`id`required	`string`
`workspace_id`required	`string`
`workspace_name`required	`string`
`client_name`required	`string`
`period`required	`string`
`status`required	`enum`	Values `draft \| generated \| sent \| failed`
`metrics`required	`object`
`metrics.tickets_received`required	`integer`
`metrics.tickets_resolved`required	`integer`
`metrics.median_first_response_minutes`required	`number`
`metrics.median_release_minutes`required	`number`
`metrics.releases`required	`integer`
`metrics.proactive_fixes`required	`integer`
`metrics.top_modules`required	`array of object`
`metrics.top_modules[].module`required	`string`
`metrics.top_modules[].tickets`required	`integer`
`metrics.by_category`required	`object`
`intro_md`required	`string`
`sent_to`required	`array of string (email)`
`sent_at`required	`string (date-time)`
`generated_at`required	`string (date-time)`
`created_at`required	`string (date-time)`
`pdf_path`required	`string`

GET`/v1/agency/reports/{id}`

One monthly client report.

Authentication: Dashboard session

Parameters

Parameters, GET /v1/agency/reports/{id}
Name	Type	Description
`id`pathrequired	`string`

Response `200`

The same fields as POST /v1/agency/reports.

POST`/v1/agency/reports/{id}/send`

Emails the report with the agency brand to its recipients.

Authentication: Dashboard session

Parameters

Parameters, POST /v1/agency/reports/{id}/send
Name	Type	Description
`id`pathrequired	`string`

Request body

Request body, POST /v1/agency/reports/{id}/send
Name	Type	Description
`recipients`	`array of string`

Response `200`

The same fields as POST /v1/agency/reports.

GET`/v1/agency/resale`

Resale prices, workspace costs and margins of every client.

Authentication: Dashboard session

Response `200`

Response, GET /v1/agency/resale
Name	Type	Description
`plan`required	`enum`	Values `none \| open_source \| indie \| startup \| growth \| managed \| agency \| enterprise`
`currency`required	`"USD"`
`clients`required	`array of object`
`clients[].workspace_id`required	`string`
`clients[].workspace_name`required	`string`
`clients[].client_name`required	`string`
`clients[].resale_price`required	`number`
`clients[].unit_cost_usd`required	`number`
`clients[].margin_usd`required	`number`
`clients[].collect_via_connect`required	`boolean`
`clients[].managed_addon`required	`boolean`
`clients[].collection`required	`object`
`clients[].collection.status`required	`enum`	Values `pending \| active \| past_due \| canceled`
`clients[].collection.client_email`required	`string (email)`
`clients[].collection.hosted_invoice_url`required	`string`
`clients[].collection.last_check`required	`enum`	Values `verified \| mismatch`
`totals`required	`object`
`totals.revenue_usd`required	`number`
`totals.cost_usd`required	`number`
`totals.margin_usd`required	`number`
`totals.priced_clients`required	`integer`
`totals.collected_margin_this_month_usd`required	`number`
`connect`required	`object`
`connect.status`required	`enum`	Values `not_started \| pending \| active \| restricted`
`connect.account_linked`required	`boolean`
`connect.charges_enabled`required	`boolean`
`connect.payouts_enabled`required	`boolean`
`connect.collecting_clients`required	`integer`

GET`/v1/agency/white-label`

White-label readiness of every client: brand, sender, domains.

Authentication: Dashboard session

Response `200`

Response, GET /v1/agency/white-label
Name	Type	Description
`default_profile`required	`object`
`default_profile.id`required	`string`
`default_profile.name`required	`string`
`default_profile.logo`required	`boolean`
`default_profile.primary_color`required	`string`
`profiles`required	`array of object`
`profiles[].id`required	`string`
`profiles[].name`required	`string`
`profiles[].is_default`required	`boolean`
`clients`required	`array of object`
`clients[].workspace_id`required	`string`
`clients[].workspace_name`required	`string`
`clients[].client_name`required	`string`
`clients[].brand_profile_id`required	`string`
`clients[].effective_profile_id`required	`string`
`clients[].brand_name`required	`string`
`clients[].ready`required	`boolean`
`clients[].missing`required	`array of enum`
`clients[].sender`required	`string`
`clients[].sending_domain`required	`object`
`clients[].sending_domain.domain`required	`string`
`clients[].sending_domain.verified`required	`boolean`
`clients[].inbound_domain`required	`object`
`clients[].inbound_domain.domain`required	`string`
`clients[].inbound_domain.verified`required	`boolean`
`clients[].status_domain`required	`object`
`clients[].status_domain.domain`required	`string`
`clients[].status_domain.verified`required	`boolean`
`clients[].status_base_url`required	`string (uri)`
`clients[].drafts_waiting`required	`integer`
`ready`required	`integer`
`total`required	`integer`

Name

Type

Description

idpathrequired

string

periodquery

string

Name

Type

Description

cardrequired

object

card.workspace_idrequired

string

card.workspace_namerequired

string

card.client_namerequired

string

card.slugrequired

string

card.open_ticketsrequired

integer

card.awaiting_approvalrequired

integer

card.escalationsrequired

integer

card.sla_breachedrequired

integer

card.tickets_receivedrequired

integer

card.tickets_resolvedrequired

integer

card.median_first_response_minutesrequired

number

card.median_release_minutesrequired

number

card.proactive_fixesrequired

integer

card.last_releaserequired

object

card.last_release.idrequired

string

card.last_release.versionrequired

string

card.last_release.tagrequired

string

card.last_release.released_atrequired

string (date-time)

card.slarequired

object

card.sla.first_response_minutesrequired

integer

card.sla.resolution_minutesrequired

integer

card.resale_pricerequired

number

card.white_label_missingrequired

array of enum

settingsrequired

object

settings.slarequired

object

settings.sla.first_response_minutesrequired

integer

settings.sla.resolution_minutesrequired

integer

settings.report_recipientsrequired

array of string (email)

settings.report_introrequired

string

settings.report_auto_sendrequired

boolean

settings.patterns_opt_inrequired

boolean

settings.organization_patterns_opt_inrequired

boolean

settings.localerequired

enum

Values en | it

settings.brand_profile_idrequired

string

settings.resale_pricerequired

number

settings.collect_via_connectrequired

boolean

settings.managed_addonrequired

boolean

status_base_urlrequired

string (uri)

brand_namerequired

string

Name

Type

Description

periodquery

string

Name

Type

Description

periodrequired

string

clientsrequired

array of object

clients[].workspace_idrequired

string

clients[].workspace_namerequired

string

clients[].client_namerequired

string

clients[].slugrequired

string

clients[].open_ticketsrequired

integer

clients[].awaiting_approvalrequired

integer

clients[].escalationsrequired

integer

clients[].sla_breachedrequired

integer

clients[].tickets_receivedrequired

integer

clients[].tickets_resolvedrequired

integer

clients[].median_first_response_minutesrequired

number

clients[].median_release_minutesrequired

number

clients[].proactive_fixesrequired

integer

clients[].last_releaserequired

object

clients[].last_release.idrequired

string

clients[].last_release.versionrequired

string

clients[].last_release.tagrequired

string

clients[].last_release.released_atrequired

string (date-time)

clients[].slarequired

object

clients[].sla.first_response_minutesrequired

integer

clients[].sla.resolution_minutesrequired

integer

clients[].resale_pricerequired

number

clients[].white_label_missingrequired

array of enum

totalsrequired

object

totals.clientsrequired

integer

totals.open_ticketsrequired

integer

totals.awaiting_approvalrequired

integer

totals.escalationsrequired

integer

totals.sla_breachedrequired

integer

totals.tickets_receivedrequired

integer

totals.tickets_resolvedrequired

integer

totals.proactive_fixesrequired

integer

totals.median_first_response_minutesrequired

number

totals.median_release_minutesrequired

number

Name

Type

Description

statusrequired

enum

Values none | pending | certified

profilerequired

object

profile.idrequired

string

profile.public_namerequired

string

profile.website_urlrequired

string (uri)

profile.descriptionrequired

string

profile.countryrequired

string

profile.logo_urlrequired

string (uri)

profile.certified_atrequired

string (date-time)

profile.listedrequired

boolean

profile.commission_raterequired

number

profile.review_requested_atrequired

string (date-time)

profile.created_atrequired

string (date-time)

referral_coderequired

string

referred_customersrequired

integer

Name

Type

Description

public_namerequired

string

website_urlrequired

string

descriptionrequired

string

countryrequired

string

logo_urlrequired

string

Name

Type

Description

cursorquery

string

limitquery

integer

clientquery

array of string

kindquery

array of enum

slaquery

array of enum

min_age_minutesquery

integer

max_age_minutesquery

integer

sortquery

enum

Values urgency | oldest | newest

Name

Type

Description

itemsrequired

array of object

items[].kindrequired

enum

Values draft | fix | escalation

items[].ticketrequired

object

items[].ticket.idrequired

string

items[].ticket.org_idrequired

string

items[].ticket.workspace_idrequired

string

items[].ticket.workspace_namerequired

string

items[].ticket.client_namerequired

string

items[].ticket.channel_idrequired

string

items[].ticket.originrequired

enum

Values email | widget | github | proactive

items[].ticket.external_idrequired

string

items[].ticket.customer_emailrequired

string

items[].ticket.customer_namerequired

string

items[].ticket.subjectrequired

string

items[].ticket.staterequired

enum

Values

received | triage | needs_info | draft_ready | answered | fixing | awaiting_approval | releasing | customer_notified | closed | escalated

items[].ticket.public_staterequired

enum

items[].ticket.categoryrequired

enum

items[].ticket.priorityrequired

enum

Values low | normal | high | urgent

items[].ticket.assignee_user_idrequired

string

items[].ticket.github_item_kindrequired

enum

Values issue | pull_request

items[].ticket.github_numberrequired

integer

items[].ticket.labelsrequired

array of string

items[].ticket.languagerequired

string

items[].ticket.is_demorequired

boolean

items[].ticket.demorequired

boolean

items[].ticket.error_group_idrequired

string

items[].ticket.duplicate_of_ticket_idrequired

string

items[].ticket.resolved_versionrequired

string

items[].ticket.latest_confidencerequired

number

items[].ticket.needs_team_actionrequired

boolean

items[].ticket.message_countrequired

integer

items[].ticket.last_message_atrequired

string (date-time)

items[].ticket.first_response_atrequired

string (date-time)

items[].ticket.released_atrequired

string (date-time)

items[].ticket.closed_atrequired

string (date-time)

items[].ticket.last_customer_message_atrequired

string (date-time)

items[].ticket.sla_due_atrequired

string (date-time)

items[].ticket.reopened_countrequired

integer

items[].ticket.created_atrequired

string (date-time)

items[].ticket.updated_atrequired

string (date-time)

items[].waiting_sincerequired

string (date-time)

items[].waiting_minutesrequired

integer

items[].summaryrequired

string

items[].fixrequired

object

items[].fix.idrequired

string

items[].fix.attempt_numberrequired

integer

items[].fix.pr_numberrequired

integer

items[].fix.pr_urlrequired

string (uri)

items[].fix.head_sharequired

string

items[].fix.statusrequired

enum

Values prepared | proposed

items[].fix.verified_byrequired

enum

Values harness | agent | server

items[].fix.tests_passedrequired

boolean

items[].fix.diff_statsrequired

object

items[].fix.diff_stats.files_changedrequired

integer

items[].fix.diff_stats.additionsrequired

integer

items[].fix.diff_stats.deletionsrequired

integer

items[].slarequired

object

items[].sla.first_responserequired

object

items[].sla.first_response.due_atrequired

string (date-time)

items[].sla.first_response.statusrequired

enum

Values none | pending | breached | met | missed

items[].sla.first_response.remaining_minutesrequired

integer

items[].sla.resolutionrequired

object

items[].sla.resolution.due_atrequired

string (date-time)

items[].sla.resolution.statusrequired

enum

Values none | pending | breached | met | missed

items[].sla.resolution.remaining_minutesrequired

integer

items[].sla.breachedrequired

boolean

items[].sla.due_soonrequired

boolean

items[].sla.next_due_atrequired

string (date-time)

next_cursorrequired

string

releasesrequired

array of object

releases[].idrequired

string

releases[].org_idrequired

string

releases[].workspace_idrequired

string

releases[].repository_idrequired

string

releases[].tagrequired

string

releases[].versionrequired

string

releases[].sharequired

string

releases[].merged_sharequired

string

releases[].statusrequired

enum

releases[].ci_statusrequired

enum

Values pending | running | success | failure | none

Name

Type

Description

cursorquery

string

limitquery

integer

workspace_idquery

string

periodquery

string

Name

Type

Description

itemsrequired

array of object

items[].idrequired

string

items[].workspace_idrequired

string

items[].workspace_namerequired

string

items[].client_namerequired

string

items[].periodrequired

string

items[].statusrequired

enum

Values draft | generated | sent | failed

items[].metricsrequired

object

items[].metrics.tickets_receivedrequired

integer

items[].metrics.tickets_resolvedrequired

integer

items[].metrics.median_first_response_minutesrequired

number

items[].metrics.median_release_minutesrequired

number

items[].metrics.releasesrequired

integer

items[].metrics.proactive_fixesrequired

integer

items[].metrics.top_modulesrequired

array of object

items[].metrics.top_modules[].modulerequired

string

items[].metrics.top_modules[].ticketsrequired

integer

items[].metrics.by_categoryrequired

object

items[].intro_mdrequired

string

items[].sent_torequired

array of string (email)

items[].sent_atrequired

string (date-time)

items[].generated_atrequired

string (date-time)

items[].created_atrequired

string (date-time)

items[].pdf_pathrequired

string

next_cursorrequired

string

latest_periodrequired

string

Name

Type

Description

workspace_idrequired

string

periodrequired

string

regenerate

boolean

Name

Type

Description

idrequired

string

workspace_idrequired

string

workspace_namerequired

string

client_namerequired

string

periodrequired

string

statusrequired

enum

Values draft | generated | sent | failed

metricsrequired

object

metrics.tickets_receivedrequired

integer

metrics.tickets_resolvedrequired

integer

metrics.median_first_response_minutesrequired

number

metrics.median_release_minutesrequired

number

metrics.releasesrequired

integer

metrics.proactive_fixesrequired

integer

metrics.top_modulesrequired

array of object

metrics.top_modules[].modulerequired

string

metrics.top_modules[].ticketsrequired

integer

metrics.by_categoryrequired

object

intro_mdrequired

string

sent_torequired

array of string (email)

sent_atrequired

string (date-time)

generated_atrequired

string (date-time)

created_atrequired

string (date-time)

pdf_pathrequired

string

Name

Type

Description

idpathrequired

string

Name

Type

Description

idpathrequired

string

Name

Type

Description

recipients

array of string

Name

Type

Description

planrequired

enum

currencyrequired

"USD"

clientsrequired

array of object

clients[].workspace_idrequired

string

clients[].workspace_namerequired

string

clients[].client_namerequired

string

clients[].resale_pricerequired

number

clients[].unit_cost_usdrequired

number

clients[].margin_usdrequired

number

clients[].collect_via_connectrequired

boolean

clients[].managed_addonrequired

boolean

clients[].collectionrequired

object

clients[].collection.statusrequired

enum

Values pending | active | past_due | canceled

clients[].collection.client_emailrequired

string (email)

clients[].collection.hosted_invoice_urlrequired

string

clients[].collection.last_checkrequired

enum

Values verified | mismatch

totalsrequired

object

totals.revenue_usdrequired

number

totals.cost_usdrequired

number

totals.margin_usdrequired

number

totals.priced_clientsrequired

integer

totals.collected_margin_this_month_usdrequired

number

connectrequired

object

connect.statusrequired

enum

Values not_started | pending | active | restricted

connect.account_linkedrequired

boolean

connect.charges_enabledrequired

boolean

connect.payouts_enabledrequired

boolean

connect.collecting_clientsrequired

integer

Name

Type

Description

default_profilerequired

object

default_profile.idrequired

string

default_profile.namerequired

string

default_profile.logorequired

boolean

default_profile.primary_colorrequired

string

profilesrequired

array of object

profiles[].idrequired

string

profiles[].namerequired

string

profiles[].is_defaultrequired

boolean

clientsrequired

array of object

clients[].workspace_idrequired

string

clients[].workspace_namerequired

string

clients[].client_namerequired

string

clients[].brand_profile_idrequired

string

clients[].effective_profile_idrequired

string

clients[].brand_namerequired

string

clients[].readyrequired

boolean

clients[].missingrequired

array of enum

clients[].senderrequired

string

clients[].sending_domainrequired

object

clients[].sending_domain.domainrequired

string

clients[].sending_domain.verifiedrequired

boolean

clients[].inbound_domainrequired

object

clients[].inbound_domain.domainrequired

string

clients[].inbound_domain.verifiedrequired

boolean

clients[].status_domainrequired

object

clients[].status_domain.domainrequired

string

clients[].status_domain.verifiedrequired

boolean

clients[].status_base_urlrequired

string (uri)

clients[].drafts_waitingrequired

integer

readyrequired

integer

totalrequired

integer

GET/v1/agency/clients/{id}

Parameters

Response 200

GET/v1/agency/overview

Parameters

Response 200

GET/v1/agency/partner

Response 200

PUT/v1/agency/partner

Request body

Response 200

GET/v1/agency/queue

Parameters

Response 200

GET/v1/agency/reports

Parameters

Response 200

POST/v1/agency/reports

Request body

Response 201

GET/v1/agency/reports/{id}

Parameters

Response 200

POST/v1/agency/reports/{id}/send

Parameters

Request body

Response 200

GET/v1/agency/resale

Response 200

GET/v1/agency/white-label

Response 200

GET/v1/agency/clients/{id}

Parameters

Response 200

GET/v1/agency/overview

Parameters

Response 200

GET/v1/agency/partner

Response 200

PUT/v1/agency/partner

Request body

Response 200

GET/v1/agency/queue

Parameters

Response 200

GET/v1/agency/reports

Parameters

Response 200

POST/v1/agency/reports

Request body

Response 201

GET/v1/agency/reports/{id}

Parameters

Response 200

POST/v1/agency/reports/{id}/send

Parameters

Request body

Response 200

GET/v1/agency/resale

Response 200

GET/v1/agency/white-label

Response 200

GET`/v1/agency/clients/{id}`

Response `200`

GET`/v1/agency/overview`

Response `200`

GET`/v1/agency/partner`

Response `200`

PUT`/v1/agency/partner`

Response `200`

GET`/v1/agency/queue`

Response `200`

GET`/v1/agency/reports`

Response `200`

POST`/v1/agency/reports`

Response `201`

GET`/v1/agency/reports/{id}`

Response `200`

POST`/v1/agency/reports/{id}/send`

Response `200`

GET`/v1/agency/resale`

Response `200`

GET`/v1/agency/white-label`

Response `200`

GET`/v1/agency/clients/{id}`

Response `200`

GET`/v1/agency/overview`

Response `200`

GET`/v1/agency/partner`

Response `200`

PUT`/v1/agency/partner`

Response `200`

GET`/v1/agency/queue`

Response `200`

GET`/v1/agency/reports`

Response `200`

POST`/v1/agency/reports`

Response `201`

GET`/v1/agency/reports/{id}`

Response `200`

POST`/v1/agency/reports/{id}/send`

Response `200`

GET`/v1/agency/resale`

Response `200`

GET`/v1/agency/white-label`

Response `200`