api_service: Analytics API
compatibility_target: v63.0
entry_points:
  - label: Download Resource Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_download_reference_resource.htm
  - label: Notifications Resource Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_notifications_reference_resource.htm
  - label: Dashboard Resource Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_resource_reference.htm
  - label: Filter Operators Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_filteroperators_reference_resource.htm
  - label: Folders Resource Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_reference_resource.htm
  - label: Analytics REST API Resource Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/sforce_analytics_rest_api_resource_reference.htm
  - label: Report Types Resource Reference
    url: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_reporttypes_reference_resource.htm
categories:
  - category: Download
    endpoints: []
  - category: Notifications
    endpoints: []
  - category: Reports
    endpoints:
      - name: List Reports
        method: GET
        path: /services/data/v63.0/analytics/reports
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/sforce_analytics_rest_api_recentreportslist.htm
        coverage: covered
        test_file: reports/get_reports_test.go
      - name: Create Report
        method: POST
        path: /services/data/v63.0/analytics/reports
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/sforce_analytics_rest_api_recentreportslist.htm
        coverage: done
        test_file: reports/report_lifecycle_test.go
      - name: Run Report
        method: GET
        path: /services/data/v63.0/analytics/reports/{reportId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/sforce_analytics_rest_api_getreportrundata.htm
        coverage: done
        test_file: reports/report_lifecycle_test.go
      - name: Run Report With Runtime Filters
        method: POST
        path: /services/data/v63.0/analytics/reports/{reportId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/sforce_analytics_rest_api_getreportrundata.htm
        coverage: done
        test_file: reports/report_lifecycle_test.go
      - name: Update Report
        method: PATCH
        path: /services/data/v63.0/analytics/reports/{reportId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_report_list_resource.htm
        coverage: done
        test_file: reports/report_lifecycle_test.go
      - name: Delete Report
        method: DELETE
        path: /services/data/v63.0/analytics/reports/{reportId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_report_list_resource.htm
        coverage: done
        test_file: reports/report_lifecycle_test.go
      - name: Describe Report
        method: GET
        path: /services/data/v63.0/analytics/reports/{reportId}/describe
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/sforce_analytics_rest_api_getbasic_reportmetadata.htm
        coverage: done
        test_file: reports/report_lifecycle_test.go
  - category: Dashboards
    endpoints:
      - name: List Dashboards
        method: GET
        path: /services/data/v63.0/analytics/dashboards
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_list_resource.htm
        coverage: covered
        test_file: dashboards/get_dashboards_test.go
      - name: Create Dashboard
        method: POST
        path: /services/data/v63.0/analytics/dashboards
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_list_resource.htm
        coverage: done
        test_file: dashboards/dashboard_lifecycle_test.go
      - name: Get Dashboard
        method: GET
        path: /services/data/v63.0/analytics/dashboards/{dashboardId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_results_resource.htm
        coverage: done
        test_file: dashboards/dashboard_lifecycle_test.go
      - name: Update Dashboard
        method: PATCH
        path: /services/data/v63.0/analytics/dashboards/{dashboardId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_results_resource.htm
        coverage: done
        test_file: dashboards/dashboard_mutations_test.go
      - name: Replace Dashboard
        method: PUT
        path: /services/data/v63.0/analytics/dashboards/{dashboardId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_results_resource.htm
        coverage: done
        test_file: dashboards/dashboard_mutations_test.go
      - name: Delete Dashboard
        method: DELETE
        path: /services/data/v63.0/analytics/dashboards/{dashboardId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_results_resource.htm
        coverage: done
        test_file: dashboards/dashboard_mutations_test.go
      - name: Refresh Dashboard
        method: POST
        path: /services/data/v63.0/analytics/dashboards/{dashboardId}/refresh
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_results_resource.htm
        coverage: done
        test_file: dashboards/dashboard_mutations_test.go
      - name: Dashboard Status
        method: GET
        path: /services/data/v63.0/analytics/dashboards/{dashboardId}/status
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_dashboard_status_resource.htm
        coverage: done
        test_file: dashboards/dashboard_mutations_test.go
  - category: Folders
    endpoints:
      - name: List Folders
        method: GET
        path: /services/data/v63.0/folders
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_create.htm
        coverage: covered
        test_file: folders/get_folders_test.go
      - name: Create Folder
        method: POST
        path: /services/data/v63.0/folders
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_create.htm
        coverage: done
        test_file: folders/folder_crud_test.go
      - name: Get Folder
        method: GET
        path: /services/data/v63.0/folders/{id}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_ops.htm
        coverage: done
        test_file: folders/folder_crud_test.go
      - name: Update Folder
        method: PATCH
        path: /services/data/v63.0/folders/{id}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_ops.htm
        coverage: done
        test_file: folders/folder_crud_test.go
      - name: Delete Folder
        method: DELETE
        path: /services/data/v63.0/folders/{id}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_ops.htm
        coverage: todo
      - name: Get Folder Children
        method: GET
        path: /services/data/v63.0/folders/{id}/children
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_children.htm
        coverage: todo
      - name: Get Folder Shares
        method: GET
        path: /services/data/v63.0/folders/{id}/shares
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_shares.htm
        coverage: todo
      - name: Create Folder Share
        method: POST
        path: /services/data/v63.0/folders/{id}/shares
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_shares.htm
        coverage: todo
      - name: Replace Folder Shares
        method: PUT
        path: /services/data/v63.0/folders/{id}/shares
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_shares.htm
        coverage: todo
      - name: Get Folder Share
        method: GET
        path: /services/data/v63.0/folders/{id}/shares/{shareId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_shares_by_id.htm
        coverage: todo
      - name: Update Folder Share
        method: PATCH
        path: /services/data/v63.0/folders/{id}/shares/{shareId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_shares_by_id.htm
        coverage: todo
      - name: Delete Folder Share
        method: DELETE
        path: /services/data/v63.0/folders/{id}/shares/{shareId}
        doc: https://developer.salesforce.com/docs/atlas.en-us.254.0.api_analytics.meta/api_analytics/analytics_api_folders_shares_by_id.htm
        coverage: todo
  - category: Filter Operators
    endpoints: []
  - category: Report Types
    endpoints: []