The reporting API from Sweep — 7 operation(s) for reporting.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sweep:sweep-reporting-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sweep Reporting API
description: This is a publicly available Sweep API.
version: '0.1'
contact: {}
servers:
- url: https://api.sweep.io
description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: Reporting
paths:
/reporting:
get:
operationId: ReportingController_getReporting
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Reporting'
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller get reporting
x-summary-source: derived
/reporting/activate/is-allowed:
get:
operationId: ReportingController_isAllowedToActivateReporting
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: boolean
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller is allowed to activate reporting
x-summary-source: derived
/reporting/activate:
patch:
operationId: ReportingController_activateReporting
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Reporting'
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller activate reporting
x-summary-source: derived
/reporting/{reportingId}/deactivate:
post:
operationId: ReportingController_deactivateReporting
parameters:
- name: reportingId
required: true
in: path
schema:
type: string
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Reporting'
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller deactivate reporting
x-summary-source: derived
/reporting/reports:
get:
operationId: ReportingController_getAllSfdcReports
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller get all sfdc reports
x-summary-source: derived
/reporting/reports/tabular:
get:
operationId: ReportingController_getSfdcTabularReports
parameters: []
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller get sfdc tabular reports
x-summary-source: derived
/reporting/reports/{reportId}/columns:
get:
operationId: ReportingController_getSfdcReportColumns
parameters:
- name: reportId
required: true
in: path
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
type: object
security:
- bearer: []
tags:
- Reporting
summary: Reporting controller get sfdc report columns
x-summary-source: derived
components:
schemas:
Account:
type: object
properties:
id:
type: string
name:
type: string
authZeroOrgId:
type: string
createdAt:
format: date-time
type: string
updatedAt:
format: date-time
type: string
deletedAt:
format: date-time
type: string
onboardingStep:
type: string
enum:
- ConnectOrg
- Completed
trialStartDate:
format: date-time
type: string
trialEndDate:
format: date-time
type: string
type:
type: string
enum:
- Customer
- POC
- Inactive
- SI
- Free
- Internal
roleGroups:
type: array
items:
$ref: '#/components/schemas/RoleGroup'
users:
type: array
items:
$ref: '#/components/schemas/User'
disableAi:
type: boolean
isBuildModeEnabled:
type: boolean
lastSeen:
format: date-time
type: string
allowedIpRanges:
type:
- array
- 'null'
items:
type: string
required:
- id
- name
- authZeroOrgId
- createdAt
- updatedAt
- deletedAt
- onboardingStep
- trialStartDate
- trialEndDate
- type
- roleGroups
- users
- disableAi
- isBuildModeEnabled
- lastSeen
- allowedIpRanges
FunnelDetailsDto:
type: object
properties:
leadingObject:
$ref: '#/components/schemas/LeadingObjectDto'
stages:
type: array
items:
$ref: '#/components/schemas/SweepStage'
_firstStageId:
type: string
plugins:
default: {}
allOf:
- $ref: '#/components/schemas/FunnelPluginsDto'
funnelLinks:
type: array
items:
$ref: '#/components/schemas/FunnelLinkDto'
stageMetadata:
type: array
items:
type: object
required:
- leadingObject
- stages
- plugins
RoleGroupOrgRole:
type: object
properties:
role:
type: object
crmOrgId:
type: string
crmOrg:
$ref: '#/components/schemas/CrmOrg'
roleGroupId:
type: string
roleGroup:
$ref: '#/components/schemas/RoleGroup'
required:
- role
- crmOrgId
- crmOrg
- roleGroupId
- roleGroup
SweepAssignmentRule:
type: object
properties:
assignmentId:
type: string
ruleName:
type: string
assignedTo:
type: string
assignedToType:
type: string
criteriaLogic:
type: string
criteria:
type: array
items:
type: object
required:
- assignmentId
- ruleName
- assignedTo
- assignedToType
- criteriaLogic
- criteria
RoleGroup:
type: object
properties:
id:
type: string
accountId:
type: string
account:
$ref: '#/components/schemas/Account'
type:
type: string
enum:
- SYSTEM
- USER_CREATED
accountRoles:
type: array
items:
$ref: '#/components/schemas/RoleGroupAccountRole'
orgRoles:
type: array
items:
$ref: '#/components/schemas/RoleGroupOrgRole'
createdById:
type: string
createdBy:
$ref: '#/components/schemas/User'
createdAt:
format: date-time
type: string
updatedById:
type: string
updatedBy:
$ref: '#/components/schemas/User'
updatedAt:
format: date-time
type: string
name:
type: string
description:
type: string
required:
- id
- accountId
- account
- type
- accountRoles
- orgRoles
- createdById
- createdBy
- createdAt
- updatedById
- updatedBy
- updatedAt
- name
User:
type: object
properties:
id:
type: string
sub:
type: string
email:
type: string
account:
$ref: '#/components/schemas/Account'
preferences:
type: object
name:
type: string
emoji:
type: string
imageUrl:
type: string
jobTitle:
type: string
roleGroup:
$ref: '#/components/schemas/RoleGroup'
roleGroupId:
type: string
createdAt:
format: date-time
type: string
updatedAt:
format: date-time
type: string
deletedAt:
format: date-time
type: string
lastSeen:
format: date-time
type: string
required:
- id
- sub
- email
- account
- preferences
- name
- emoji
- imageUrl
- jobTitle
- roleGroup
- roleGroupId
- createdAt
- updatedAt
SweepStage:
type: object
properties:
stageName:
type: string
_stageId:
type: string
stageDescription:
type: string
_branchIndex:
type: number
_stageColumnIndex:
type: number
exitCriteria:
type: array
items:
$ref: '#/components/schemas/SweepExitCriteria'
assignmentRules:
type: array
items:
$ref: '#/components/schemas/SweepAssignmentRule'
_team:
type: string
stageType:
type: string
enum:
- regular
- lost
- nurturing
preventBackwardStages:
type: boolean
funnelLinks:
type: array
items:
$ref: '#/components/schemas/FunnelLinkDto'
additionalFields:
default: []
type: array
items:
$ref: '#/components/schemas/SweepFieldReference'
required:
- stageName
- _stageId
- stageDescription
- exitCriteria
- assignmentRules
FunnelLinkDto:
type: object
properties:
_id:
type: string
_type:
type: string
enum:
- salesforce
- thirdParty
- recordType
- hubspot
- metadataElement
funnelId:
type: string
stageId:
type: string
required:
- _id
- _type
- funnelId
FunnelSnapshot:
type: object
properties:
id:
type: string
ord:
type: number
createdById:
type: string
createdBy:
$ref: '#/components/schemas/User'
apiName:
type: string
accountId:
type: string
account:
$ref: '#/components/schemas/Account'
name:
type: string
funnelName:
type: string
description:
type: string
recordTypeName:
type: string
restoredFromSnapshot:
type: number
funnelDetails:
$ref: '#/components/schemas/FunnelDetailsDto'
deployments:
type: array
items:
$ref: '#/components/schemas/FunnelDeployment'
createdAt:
format: date-time
type: string
required:
- id
- ord
- createdById
- createdBy
- apiName
- accountId
- account
- name
- funnelName
- description
- recordTypeName
- restoredFromSnapshot
- funnelDetails
- deployments
- createdAt
CrmOrg:
type: object
properties:
id:
type: string
org:
$ref: '#/components/schemas/Org'
name:
type: string
platform:
type: string
instanceUrl:
type: string
isSandbox:
type: boolean
isMain:
type: boolean
isDemo:
type: boolean
isConnected:
type: object
default: false
createdById:
type: string
createdBy:
$ref: '#/components/schemas/User'
fetchStatus:
enum:
- fetching
- initial_fetching
- error
- fetched
- invalid_credentials
type: string
lastSuccessfulFetchTs:
type: number
disconnectedAt:
format: date-time
type:
- string
- 'null'
createdAt:
format: date-time
type: string
updatedAt:
format: date-time
type: string
accountId:
type: string
connectedUser:
type: string
account:
$ref: '#/components/schemas/Account'
deployments:
type: array
items:
$ref: '#/components/schemas/FunnelDeployment'
optMonitoring:
type: boolean
graphVersion:
type:
- string
- 'null'
graphDbReleaseChannel:
enum:
- stable
- beta
- shadow
type:
- string
- 'null'
tier:
enum:
- T0
- T1
type: string
required:
- id
- org
- name
- platform
- instanceUrl
- isSandbox
- isMain
- isDemo
- isConnected
- createdById
- createdBy
- fetchStatus
- lastSuccessfulFetchTs
- disconnectedAt
- createdAt
- updatedAt
- accountId
- connectedUser
- account
- deployments
- optMonitoring
- graphVersion
- graphDbReleaseChannel
- tier
SweepExitCriteria:
type: object
properties:
_exitCriteriaId:
type: string
_nextStageId:
type: string
isAutoMoveToNextStage:
type: boolean
guidance:
type: string
criteria:
type: array
items:
type: object
criteriaLogic:
type: string
required:
- _exitCriteriaId
- criteria
- criteriaLogic
FunnelPluginsDto:
type: object
properties: {}
LeadingObjectDto:
type: object
properties:
objectName:
type: string
fieldName:
type: string
_leadingFieldLabels:
type: array
items:
type: string
_leadingFieldId:
type: string
required:
- objectName
- fieldName
- _leadingFieldId
RoleGroupAccountRole:
type: object
properties:
role:
type: object
roleGroupId:
type: string
roleGroup:
$ref: '#/components/schemas/RoleGroup'
required:
- role
- roleGroupId
- roleGroup
SweepFieldReference:
type: object
properties:
fieldIds:
type: array
items:
type: string
fieldSource:
type: string
required:
- fieldIds
FunnelDeployment:
type: object
properties:
id:
type: string
crmOrgId:
type: string
crmOrg:
$ref: '#/components/schemas/CrmOrg'
snapshotId:
type: string
snapshot:
$ref: '#/components/schemas/FunnelSnapshot'
deployedById:
type: string
deployedBy:
$ref: '#/components/schemas/User'
deployedAt:
format: date-time
type: string
status:
type: object
required:
- id
- crmOrgId
- crmOrg
- snapshotId
- snapshot
- deployedById
- deployedBy
- deployedAt
- status
Reporting:
type: object
properties:
id:
type: string
accountId:
type: string
account:
$ref: '#/components/schemas/Account'
name:
type: string
type:
enum:
- AePerformance
- Forecasting
- FunnelConversion
- LeadOverview
- Velocity
type: string
status:
type: object
url:
type: string
createdById:
type: string
createdBy:
$ref: '#/components/schemas/User'
createdAt:
format: date-time
type: string
updatedById:
type: string
updatedBy:
$ref: '#/components/schemas/User'
updatedAt:
format: date-time
type: string
required:
- id
- accountId
- account
- name
- type
- status
- url
- createdById
- createdBy
- createdAt
- updatedById
- updatedBy
- updatedAt
Org:
type: object
properties:
id:
type: string
accountId:
type: string
account:
$ref: '#/components/schemas/Account'
required:
- id
- accountId
- account
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http