> ## Documentation Index > Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a report config > Get a single report configuration by oId ## OpenAPI ````yaml get /api/v2/report-config/get openapi: 3.0.0 info: version: 1.0.0 title: Octave API description: API for Octave workspace management and AI-powered content generation servers: - url: https://app.octavehq.com security: - ApiKeyAuth: [] paths: /api/v2/report-config/get: get: tags: - ReportConfig summary: Get a report config description: Get a single report configuration by oId operationId: getReportConfig parameters: - schema: type: string description: Report config oId example: rc_abc123 required: true name: oId in: query responses: '200': description: Report config content: application/json: schema: type: object properties: _metadata: $ref: '#/components/schemas/Metadata' data: $ref: '#/components/schemas/ReportConfig' required: - _metadata - data deprecated: false components: schemas: Metadata: type: object properties: usage: type: number default: 0 description: API usage example: 0 requestId: type: string description: Request ID example: requestId message: type: string description: Message example: message timestamp: type: string description: Timestamp example: '2021-01-01T00:00:00.000Z' required: - requestId - timestamp ReportConfig: type: object properties: oId: type: string title: type: string description: type: string executionType: type: string enum: - octave - adhoc default: adhoc reportId: type: string prompt: type: string systemPrompt: type: string logicVersion: type: number default: 1 filters: type: object properties: findings: type: array items: type: object properties: type: type: string enum: - EMAIL_INTERNAL_USE_CASE - EMAIL_INTERNAL_PROOF_POINT - EMAIL_INTERNAL_PAIN_POINT - EMAIL_INTERNAL_BENEFITS_HIGHLIGHTED - EMAIL_INTERNAL_VALUE_PROP - EMAIL_INTERNAL_SOCIAL_PROOF - EMAIL_INTERNAL_CALL_TO_ACTION - EMAIL_INTERNAL_OBJECTION_HANDLING - EMAIL_EXTERNAL_CALL_TO_ACTION - EMAIL_EXTERNAL_OBJECTION - EMAIL_EXTERNAL_QUESTION - EMAIL_EXTERNAL_INTEREST_EXPRESSION - EMAIL_EXTERNAL_FEATURE_REQUEST - EMAIL_EXTERNAL_REQUIREMENT - EMAIL_EXTERNAL_PRICING_FEEDBACK - EMAIL_EXTERNAL_COMPARATIVE_STATEMENT - EMAIL_EXTERNAL_KEY_TAKEAWAY - EMAIL_EXTERNAL_COMPETITOR_MENTION - EMAIL_EXTERNAL_NEXT_STEP - EMAIL_EXTERNAL_URGENCY_INDICATOR - EMAIL_EXTERNAL_DECISION_MAKING_SIGNAL - EMAIL_EXTERNAL_UNIQUE_LANGUAGE_USED - EMAIL_OVERALL_SENTIMENT - EMAIL_INTERNAL_TITLE_TO_PERSONA - EMAIL_EXTERNAL_TITLE_TO_PERSONA - EMAIL_SEGMENT_DESCRIPTION - SOCIAL_INTERNAL_USE_CASE - SOCIAL_INTERNAL_PROOF_POINT - SOCIAL_INTERNAL_PAIN_POINT - SOCIAL_INTERNAL_VALUE_PROP - SOCIAL_INTERNAL_SOCIAL_PROOF - SOCIAL_INTERNAL_CALL_TO_ACTION - SOCIAL_INTERNAL_BENEFITS_HIGHLIGHTED - SOCIAL_INTERNAL_OBJECTION_HANDLING - SOCIAL_INTERNAL_TITLE_TO_PERSONA - SOCIAL_SEGMENT_DESCRIPTION - SOCIAL_PLAYBOOK_TOPICS - SOCIAL_EXTERNAL_CALL_TO_ACTION - SOCIAL_EXTERNAL_OBJECTION - SOCIAL_EXTERNAL_QUESTION - SOCIAL_EXTERNAL_INTEREST_EXPRESSION - SOCIAL_EXTERNAL_FEATURE_REQUEST - SOCIAL_EXTERNAL_REQUIREMENT - SOCIAL_EXTERNAL_PRICING_FEEDBACK - SOCIAL_EXTERNAL_COMPARATIVE_STATEMENT - SOCIAL_EXTERNAL_KEY_TAKEAWAY - SOCIAL_EXTERNAL_COMPETITOR_MENTION - SOCIAL_EXTERNAL_NEXT_STEP - SOCIAL_EXTERNAL_URGENCY_INDICATOR - SOCIAL_EXTERNAL_DECISION_MAKING_SIGNAL - SOCIAL_EXTERNAL_UNIQUE_LANGUAGE_USED - SOCIAL_EXTERNAL_TITLE_TO_PERSONA - SOCIAL_OVERALL_SENTIMENT - CALL_EXTERNAL_BUSINESS_PROBLEMS - CALL_EXTERNAL_IDEAL_SOLUTION_DESCRIPTION - CALL_EXTERNAL_PRIMARY_GOALS - CALL_EXTERNAL_WHY_ON_THIS_CALL - CALL_EXTERNAL_STATUS_QUO_HOW_THEY_SOLVE_TODAY - CALL_EXTERNAL_INDUSTRY_TRENDS - CALL_EXTERNAL_COMPETITORS_TO_OUR_OFFERING - CALL_EXTERNAL_COMPETITORS_OF_THEIR_COMPANY - CALL_EXTERNAL_CURRENT_TOOL_OR_SOLUTION_PROBLEMS - CALL_EXTERNAL_OBJECTIONS - CALL_EXTERNAL_PAIN_OR_PROBLEM_AGREEMENTS - CALL_EXTERNAL_ROLE_OR_RESPONSIBILITIES_DESCRIPTION - CALL_EXTERNAL_QUESTIONS_OR_CONFUSION_ABOUT_OFFERING - CALL_EXTERNAL_CAPABILITIES_THAT_DREW_EXCITEMENT - CALL_EXTERNAL_UNIQUE_LANGUAGE_USED - CALL_EXTERNAL_FEATURE_REQUEST - CALL_INTERNAL_USE_CASES_BROUGHT_UP - CALL_INTERNAL_PROOF_POINTS - CALL_INTERNAL_REFERENCE_CUSTOMERS_OR_SOCIAL_PROOF - CALL_INTERNAL_COMPETITORS - CALL_INTERNAL_COMPETITORS_TO_OUR_OFFERING - CALL_INTERNAL_OBJECTION_HANDLING - CALL_INTERNAL_VALUE_PROP_PRESENTATIONS - CALL_INTERNAL_DIFFERENTIATED_VALUE - CALL_INTERNAL_CORE_CAPABILITIES - CALL_INTERNAL_COMPLEMENTARY_TOOLS_MENTIONED - RESOURCE_USE_CASES - RESOURCE_PROOF_POINTS - RESOURCE_REFERENCE_CUSTOMERS - RESOURCE_COMPETITORS - RESOURCE_OBJECTION_HANDLING - RESOURCE_VALUE_PROPS - RESOURCE_DIFFERENTIATED_VALUE - RESOURCE_CORE_CAPABILITIES - RESOURCE_SEGMENTS - RESOURCE_INTEGRATIONS_PARTNERS - RESOURCE_UNIQUE_LANGUAGE - RESOURCE_PAIN_POINTS - RESOURCE_TARGET_PERSONAS - CALL_OVERALL_SENTIMENT - CALL_PURPOSE_CLASSIFICATION - CALL_TITLE_TO_PERSONA - CALL_SEGMENT_DESCRIPTION - CRM_TITLE_TO_PERSONA - CRM_SEGMENT_DESCRIPTION - EVENT_SUMMARY - BULK_IMPORT_THEMES - BULK_LOSS_REASONS - BULK_WIN_REASONS - BULK_PAIN_POINTS - BULK_USE_CASES - BULK_COMPETITORS - BULK_OBJECTIONS - BULK_SEGMENTS - BULK_PERSONAS - ADS_INTERNAL_MESSAGING_THEME - ADS_INTERNAL_TARGET_AUDIENCE - ADS_INTERNAL_COMPETITIVE_POSITIONING - ADS_INTERNAL_KEYWORD_TARGETING - ADS_EXTERNAL_ENGAGEMENT_SIGNAL - ADS_SEGMENT_DESCRIPTION - ADS_MOTION_TYPE - ADS_OFFERING_MATCH - CALL_PROSPECT_RELATIONSHIP_TO_SELLER - CALL_MOTION_TYPE - CALL_OFFERING_MATCH - EMAIL_PROSPECT_RELATIONSHIP_TO_SELLER - EMAIL_MOTION_TYPE - EMAIL_OFFERING_MATCH - CRM_MOTION_TYPE - CRM_OFFERING_MATCH - CALL_PLAYBOOK_TOPICS - EMAIL_PLAYBOOK_TOPICS - RESOURCE_PLAYBOOK_TOPICS - EMAIL_PLAYBOOK_SOURCE - SOCIAL_PLAYBOOK_SOURCE value: type: string nullable: true required: - type events: type: object properties: match: type: object properties: eventCategories: type: array items: type: string enum: - EMAIL - CALL - CRM - RESOURCE - REVISION - SOCIAL - ADS - UNKNOWN description: Filter by event categories (CALL, EMAIL, CRM) eventTypes: type: array items: type: string enum: - EMAIL_SENT - EMAIL_REPLY_RECEIVED - CALL_TRANSCRIPT - DEAL_WON - DEAL_LOST - OPPORTUNITY_CREATED - MEETING_BOOKED - RESOURCE_INDEXED - RESOURCE_REINDEXED - ENTITY_CREATED - ENTITY_UPDATED - SOCIAL_MESSAGE_SENT - SOCIAL_MESSAGE_RECEIVED - SOCIAL_CONNECTION_SENT - SOCIAL_CONNECTION_ACCEPTED - AD_SET_PUBLISHED - AD_PERFORMANCE_SNAPSHOT - BULK_IMPORT_SUMMARY - PROCESSING_NOT_APPLICABLE - PROVIDER_EVENT_TYPE_UNKNOWN - UNKNOWN description: >- Filter by specific event types (CALL_TRANSCRIPT, EMAIL_SENT, DEAL_WON, etc.) sentiments: type: array items: type: string enum: - POSITIVE - NEUTRAL - NEGATIVE - UNKNOWN description: Filter by sentiment (POSITIVE, NEGATIVE, NEUTRAL, MIXED) contactEmails: type: array items: type: string description: Filter by participant email addresses companyDomains: type: array items: type: string description: Filter by company domains outcomeFilters: type: array items: type: string enum: - OPEN - WON - LOST - POSITIVE_REPLY - NEUTRAL_REPLY - NEGATIVE_REPLY description: >- Filter by outcome (OPEN, WON, LOST, POSITIVE_REPLY, NEUTRAL_REPLY, NEGATIVE_REPLY) opportunityStatuses: type: array items: type: string enum: - OPEN - WON - LOST description: Filter by opportunity status (OPEN, WON, LOST) minDealAmount: type: number description: Minimum deal amount filter maxDealAmount: type: number description: Maximum deal amount filter offerings: type: array items: type: string description: Filter by offering oIds personas: type: array items: type: string description: >- Filter by persona oIds (events must match these personas) segments: type: array items: type: string description: Filter by segment oIds playbooks: type: array items: type: string description: Filter by playbook oIds useCases: type: array items: type: string description: Filter by use case oIds references: type: array items: type: string description: Filter by reference customer oIds competitors: type: array items: type: string description: Filter by competitor oIds alternatives: type: array items: type: string description: Filter by alternative oIds buyingTriggers: type: array items: type: string description: Filter by buying trigger oIds objections: type: array items: type: string description: Filter by objection oIds proofPoints: type: array items: type: string description: Filter by proof point oIds motionTypes: type: array items: type: string enum: - NET_NEW - UPSELL - CROSS_SELL - CONVERT_FREE_TO_PAID - RENEW_AND_RETAIN - DISPLACE_INCUMBENT description: Filter by motion type (NET_NEW, UPSELL) unmatchedOnly: type: boolean description: >- When true, only return events that have findings with no library entity matches description: Filters to INCLUDE events matching these criteria exclude: type: object properties: eventCategories: type: array items: type: string enum: - EMAIL - CALL - CRM - RESOURCE - REVISION - SOCIAL - ADS - UNKNOWN description: Filter by event categories (CALL, EMAIL, CRM) eventTypes: type: array items: type: string enum: - EMAIL_SENT - EMAIL_REPLY_RECEIVED - CALL_TRANSCRIPT - DEAL_WON - DEAL_LOST - OPPORTUNITY_CREATED - MEETING_BOOKED - RESOURCE_INDEXED - RESOURCE_REINDEXED - ENTITY_CREATED - ENTITY_UPDATED - SOCIAL_MESSAGE_SENT - SOCIAL_MESSAGE_RECEIVED - SOCIAL_CONNECTION_SENT - SOCIAL_CONNECTION_ACCEPTED - AD_SET_PUBLISHED - AD_PERFORMANCE_SNAPSHOT - BULK_IMPORT_SUMMARY - PROCESSING_NOT_APPLICABLE - PROVIDER_EVENT_TYPE_UNKNOWN - UNKNOWN description: >- Filter by specific event types (CALL_TRANSCRIPT, EMAIL_SENT, DEAL_WON, etc.) sentiments: type: array items: type: string enum: - POSITIVE - NEUTRAL - NEGATIVE - UNKNOWN description: Filter by sentiment (POSITIVE, NEGATIVE, NEUTRAL, MIXED) contactEmails: type: array items: type: string description: Filter by participant email addresses companyDomains: type: array items: type: string description: Filter by company domains outcomeFilters: type: array items: type: string enum: - OPEN - WON - LOST - POSITIVE_REPLY - NEUTRAL_REPLY - NEGATIVE_REPLY description: >- Exclude by outcome (OPEN, WON, LOST, POSITIVE_REPLY, NEUTRAL_REPLY, NEGATIVE_REPLY) opportunityStatuses: type: array items: type: string enum: - OPEN - WON - LOST description: Exclude by opportunity status (OPEN, WON, LOST) minDealAmount: type: number description: Minimum deal amount filter maxDealAmount: type: number description: Maximum deal amount filter offerings: type: array items: type: string description: Exclude events matching these offering oIds personas: type: array items: type: string description: Exclude events matching these persona oIds segments: type: array items: type: string description: Exclude events matching these segment oIds playbooks: type: array items: type: string description: Exclude events matching these playbook oIds useCases: type: array items: type: string description: Exclude events matching these use case oIds references: type: array items: type: string description: Exclude events matching these reference customer oIds competitors: type: array items: type: string description: Exclude events matching these competitor oIds alternatives: type: array items: type: string description: Exclude events matching these alternative oIds buyingTriggers: type: array items: type: string description: Exclude events matching these buying trigger oIds objections: type: array items: type: string description: Exclude events matching these objection oIds proofPoints: type: array items: type: string description: Exclude events matching these proof point oIds motionTypes: type: array items: type: string enum: - NET_NEW - UPSELL - CROSS_SELL - CONVERT_FREE_TO_PAID - RENEW_AND_RETAIN - DISPLACE_INCUMBENT description: >- Exclude events matching these motion types (NET_NEW, UPSELL) description: Filters to EXCLUDE events matching these criteria pipelineFilters: type: object properties: phases: type: array items: type: string enum: - prospecting - discovery - evaluation - negotiation - commitment - closed_won - closed_lost description: >- Filter events linked to deals in these pipeline phases (prospecting, discovery, evaluation, negotiation, commitment, closed_won, closed_lost) stageCategories: type: array items: type: string enum: - open - closed_won - closed_lost - other description: >- Filter events linked to deals with these stage categories (open, closed_won, closed_lost, no_decision). Uses analytics-computed `stageCategory`, no stage-mapping setup required. minStalledDays: type: number description: >- Only include events linked to deals stalled in their current stage for at least this many days actions: type: array items: type: object properties: actionType: type: string enum: - ADD_ENTITY - REFINE_ENTITY - REMOVE_ENTITY - AGENTIC_ALL_MODIFICATIONS - GENERATE_LEARNINGS - GENERATE_ICP_RECOMMENDATIONS targetEntityTypes: type: array items: type: string enum: - Product - Service - Solution - Persona - UseCase - Reference - Segment - Competitor - Alternative - BuyingTrigger - Objection - ProofPoint - Playbook - Agent - Hypothesis - BrandVoice required: - actionType - targetEntityTypes metadataFields: type: array items: type: object properties: key: type: string type: type: string enum: - string - number - boolean - array_string - array_number required: type: boolean default: false required: - key - type required: - findings groupId: type: string isActive: type: boolean minEvents: type: number minFindings: type: number lastSuccessfulEndAt: type: string nullable: true consecutiveFailures: type: number notificationSettings: type: object properties: email: type: object properties: enabled: type: boolean addresses: type: array items: type: string format: email required: - enabled - addresses slack: type: object properties: enabled: type: boolean channels: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - enabled - channels required: - oId - title - filters - isActive securitySchemes: ApiKeyAuth: type: apiKey in: header name: api_key ````