API Documentation
Sales Reports ¶
Sales Reports ¶
Supported filter params
-
group (deal, manager, year, quarter, month)
-
manager_id (array)
-
tags
-
after
-
before
GET /api/v2/sales_reports
Requests
GET /api/v2/sales_reports?filter[group]=year&filter[manager_id]=4168
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "sales-report-year-2021",
"type": "sales_reports",
"attributes": {
"group": "year",
"year": 2021,
"quarter": null,
"month": null,
"deal_count": 1,
"won_deal_count": 0,
"lost_deal_count": 0,
"currency": "USD",
"currency_default": "USD",
"currency_normalized": "USD",
"revenue": 0,
"revenue_default": 0,
"revenue_normalized": 0,
"won_revenue": 0,
"won_revenue_default": 0,
"won_revenue_normalized": 0,
"lost_revenue": 0,
"lost_revenue_default": 0,
"lost_revenue_normalized": 0
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 1153
}
},
"deal": {
"data": null
},
"manager": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/sales_reports?filter%5Bgroup%5D=year&filter%5Bmanager_id%5D=4168&page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/sales_reports?filter%5Bgroup%5D=year&filter%5Bmanager_id%5D=4168&page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get sales reportsGET/api/v2/sales_reports
Generated by aglio on 23 Jan 2021