# Analytics

Inspect campaign-level and target-level activity timelines, outcomes, and execution traces.

## GET /campaigns/{campaign\_id}/activity

> Get Campaign Activity

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"campaign-analytics","description":"Inspect campaign-level and target-level activity timelines, outcomes, and execution traces."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"CampaignActivityPageOut":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CampaignActivityItemOut"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"type":"object","required":["data","meta"],"title":"CampaignActivityPageOut"},"CampaignActivityItemOut":{"properties":{"ts":{"type":"string","format":"date-time","title":"Ts"},"type":{"type":"string","enum":["call","whatsapp","email"],"title":"Type"},"status":{"type":"string","title":"Status"},"customer":{"$ref":"#/components/schemas/CustomerOut"},"campaign_id":{"type":"string","format":"uuid","title":"Campaign Id"},"campaign_target_id":{"title":"Campaign Target Id","type":"string","format":"uuid"},"agent_id":{"title":"Agent Id","type":"string","format":"uuid"},"ai_label":{"title":"Ai Label","type":"string","enum":["positive","neutral","negative","unknown"]},"conv_id":{"title":"Conv Id","type":"string"},"attempt_id":{"title":"Attempt Id","type":"string","format":"uuid"},"attempt_no":{"title":"Attempt No","type":"integer"},"outcome":{"title":"Outcome","type":"string"},"outbox_event_id":{"title":"Outbox Event Id","type":"string","format":"uuid"},"error":{"title":"Error","type":"string"}},"type":"object","required":["ts","type","status","customer","campaign_id"],"title":"CampaignActivityItemOut"},"CustomerOut":{"properties":{"customer_id":{"title":"Customer Id","type":"string","maxLength":255},"name":{"title":"Name","type":"string","maxLength":255},"surname":{"title":"Surname","type":"string","maxLength":255},"email":{"title":"Email","type":"string","format":"email"},"phone":{"title":"Phone","type":"string","maxLength":50},"status":{"title":"Status","type":"string","maxLength":50},"id":{"type":"string","format":"uuid","title":"Id"},"agent_id":{"title":"Agent Id","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","created_at","updated_at"],"title":"CustomerOut"},"PageMeta":{"properties":{"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["total","limit","offset"],"title":"PageMeta"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/campaigns/{campaign_id}/activity":{"get":{"tags":["campaign-analytics"],"summary":"Get Campaign Activity","operationId":"get_campaign_activity_campaigns__campaign_id__activity_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"title":"Campaign Id","type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"exact_total","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Exact Total"}},{"name":"obj_id","in":"query","required":false,"schema":{"title":"Obj Id","type":"string","format":"uuid"}},{"name":"agent_id","in":"query","required":false,"schema":{"title":"Agent Id","type":"string","format":"uuid"}},{"name":"customer_id","in":"query","required":false,"schema":{"title":"Customer Id","type":"string","format":"uuid"}},{"name":"knowledge_base_id","in":"query","required":false,"schema":{"title":"Knowledge Base Id","type":"string","format":"uuid"}},{"name":"id","in":"query","required":false,"schema":{"title":"Id","type":"string","format":"uuid"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignActivityPageOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## GET /campaigns/{campaign\_id}/targets/{target\_id}/activity

> Get Campaign Target Activity

```json
{"openapi":"3.1.0","info":{"title":"Umanize API","version":"0.1.0"},"tags":[{"name":"campaign-analytics","description":"Inspect campaign-level and target-level activity timelines, outcomes, and execution traces."}],"servers":[{"url":"https://api.aurorasuite.ai","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKeyAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a JWT bearer token in the Authorization header."},"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Use an API key for server-to-server integrations."}},"schemas":{"CampaignTargetActivityOut":{"properties":{"target":{"$ref":"#/components/schemas/CampaignTargetWithCustomerOut"},"call_attempts":{"items":{"$ref":"#/components/schemas/CallAttemptOut"},"type":"array","title":"Call Attempts"},"whatsapp":{"items":{"$ref":"#/components/schemas/OutboxEventOut"},"type":"array","title":"Whatsapp"},"emails":{"items":{"$ref":"#/components/schemas/OutboxEventOut"},"type":"array","title":"Emails"},"timeline":{"items":{"$ref":"#/components/schemas/ActivityItem"},"type":"array","title":"Timeline"}},"type":"object","required":["target","call_attempts","whatsapp","emails","timeline"],"title":"CampaignTargetActivityOut"},"CampaignTargetWithCustomerOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"campaign_id":{"type":"string","format":"uuid","title":"Campaign Id"},"customer_id":{"type":"string","format":"uuid","title":"Customer Id"},"assigned_agent_id":{"title":"Assigned Agent Id","type":"string","format":"uuid"},"stage":{"type":"string","title":"Stage"},"calls_made":{"type":"integer","title":"Calls Made"},"whatsapp_sent":{"type":"integer","title":"Whatsapp Sent"},"email_sent":{"type":"integer","title":"Email Sent"},"ai_label":{"type":"string","enum":["positive","negative","neutral","unknown"],"title":"Ai Label"},"ai_score":{"title":"Ai Score","type":"number"},"ai_reason":{"title":"Ai Reason","type":"string"},"goal_analysis":{"title":"Goal Analysis","additionalProperties":true,"type":"object"},"analysis_source":{"title":"Analysis Source","type":"string"},"call_successful":{"title":"Call Successful","type":"string"},"call_summary_title":{"title":"Call Summary Title","type":"string"},"transcript_summary":{"title":"Transcript Summary","type":"string"},"agent_goal_result":{"title":"Agent Goal Result","type":"string"},"agent_goal_rationale":{"title":"Agent Goal Rationale","type":"string"},"customer_sentiment":{"title":"Customer Sentiment","type":"string"},"customer_sentiment_rationale":{"title":"Customer Sentiment Rationale","type":"string"},"follow_up_required":{"title":"Follow Up Required","type":"boolean"},"follow_up_required_rationale":{"title":"Follow Up Required Rationale","type":"string"},"escalation_required":{"title":"Escalation Required","type":"boolean"},"escalation_required_rationale":{"title":"Escalation Required Rationale","type":"string"},"campaign_goal_result":{"title":"Campaign Goal Result","type":"string"},"campaign_goal_score":{"title":"Campaign Goal Score","type":"number"},"campaign_goal_rationale":{"title":"Campaign Goal Rationale","type":"string"},"campaign_sentiment":{"title":"Campaign Sentiment","type":"string"},"campaign_sentiment_rationale":{"title":"Campaign Sentiment Rationale","type":"string"},"callback_requested":{"title":"Callback Requested","type":"boolean"},"callback_requested_rationale":{"title":"Callback Requested Rationale","type":"string"},"campaign_next_best_action":{"title":"Campaign Next Best Action","type":"string"},"campaign_analysis_updated_at":{"title":"Campaign Analysis Updated At","type":"string"},"analysis_updated_at":{"title":"Analysis Updated At","type":"string"},"last_contacted_at":{"title":"Last Contacted At","type":"string","format":"date-time"},"last_email_at":{"title":"Last Email At","type":"string","format":"date-time"},"last_conv_id":{"title":"Last Conv Id","type":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"customer":{"$ref":"#/components/schemas/CustomerOut"}},"type":"object","required":["id","campaign_id","customer_id","stage","calls_made","whatsapp_sent","email_sent","ai_label","created_at","updated_at","customer"],"title":"CampaignTargetWithCustomerOut"},"CustomerOut":{"properties":{"customer_id":{"title":"Customer Id","type":"string","maxLength":255},"name":{"title":"Name","type":"string","maxLength":255},"surname":{"title":"Surname","type":"string","maxLength":255},"email":{"title":"Email","type":"string","format":"email"},"phone":{"title":"Phone","type":"string","maxLength":50},"status":{"title":"Status","type":"string","maxLength":50},"id":{"type":"string","format":"uuid","title":"Id"},"agent_id":{"title":"Agent Id","type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","created_at","updated_at"],"title":"CustomerOut"},"CallAttemptOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"attempt_no":{"type":"integer","title":"Attempt No"},"status":{"type":"string","title":"Status"},"outcome":{"title":"Outcome","type":"string"},"conv_id":{"title":"Conv Id","type":"string"},"n8n_exec_id":{"title":"N8N Exec Id","type":"string"},"direction":{"title":"Direction","type":"string"},"external_from":{"title":"External From","type":"string"},"external_to":{"title":"External To","type":"string"},"duration_seconds":{"title":"Duration Seconds","type":"number"},"messages_count":{"type":"integer","title":"Messages Count","default":0},"call_successful":{"title":"Call Successful","type":"string"},"call_summary_title":{"title":"Call Summary Title","type":"string"},"transcript_summary":{"title":"Transcript Summary","type":"string"},"agent_goal_result":{"title":"Agent Goal Result","type":"string"},"agent_goal_rationale":{"title":"Agent Goal Rationale","type":"string"},"customer_sentiment":{"title":"Customer Sentiment","type":"string"},"customer_sentiment_rationale":{"title":"Customer Sentiment Rationale","type":"string"},"follow_up_required":{"title":"Follow Up Required","type":"boolean"},"follow_up_required_rationale":{"title":"Follow Up Required Rationale","type":"string"},"escalation_required":{"title":"Escalation Required","type":"boolean"},"escalation_required_rationale":{"title":"Escalation Required Rationale","type":"string"},"campaign":{"$ref":"#/components/schemas/CampaignRef"},"scheduled_at":{"type":"string","format":"date-time","title":"Scheduled At"},"dispatched_at":{"title":"Dispatched At","type":"string","format":"date-time"},"finished_at":{"title":"Finished At","type":"string","format":"date-time"},"delivery_attempts":{"type":"integer","title":"Delivery Attempts"},"last_error":{"title":"Last Error","type":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","attempt_no","status","scheduled_at","delivery_attempts","created_at","updated_at"],"title":"CallAttemptOut"},"CampaignRef":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"CampaignRef"},"OutboxEventOut":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"type":{"type":"string","title":"Type"},"payload":{"additionalProperties":true,"type":"object","title":"Payload"},"result":{"title":"Result","additionalProperties":true,"type":"object"},"status":{"type":"string","title":"Status"},"attempts":{"type":"integer","title":"Attempts"},"next_attempt_at":{"type":"string","format":"date-time","title":"Next Attempt At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","type","payload","result","status","attempts","next_attempt_at","created_at","updated_at"],"title":"OutboxEventOut"},"ActivityItem":{"properties":{"ts":{"type":"string","format":"date-time","title":"Ts"},"type":{"type":"string","enum":["call","whatsapp","email"],"title":"Type"},"status":{"type":"string","title":"Status"},"customer":{"$ref":"#/components/schemas/CustomerMini"},"campaign_id":{"title":"Campaign Id","type":"string","format":"uuid"},"agent_id":{"title":"Agent Id","type":"string","format":"uuid"},"ai_label":{"title":"Ai Label","type":"string","enum":["positive","neutral","negative","unknown"]},"conv_id":{"title":"Conv Id","type":"string"}},"type":"object","required":["ts","type","status","customer"],"title":"ActivityItem"},"CustomerMini":{"properties":{"id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"integer"}],"title":"Id"},"name":{"title":"Name","type":"string"}},"type":"object","required":["id"],"title":"CustomerMini"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/campaigns/{campaign_id}/targets/{target_id}/activity":{"get":{"tags":["campaign-analytics"],"summary":"Get Campaign Target Activity","operationId":"get_campaign_target_activity_campaigns__campaign_id__targets__target_id__activity_get","parameters":[{"name":"campaign_id","in":"path","required":true,"schema":{"title":"Campaign Id","type":"string","format":"uuid"}},{"name":"target_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Target Id"}},{"name":"obj_id","in":"query","required":false,"schema":{"title":"Obj Id","type":"string","format":"uuid"}},{"name":"agent_id","in":"query","required":false,"schema":{"title":"Agent Id","type":"string","format":"uuid"}},{"name":"customer_id","in":"query","required":false,"schema":{"title":"Customer Id","type":"string","format":"uuid"}},{"name":"knowledge_base_id","in":"query","required":false,"schema":{"title":"Knowledge Base Id","type":"string","format":"uuid"}},{"name":"id","in":"query","required":false,"schema":{"title":"Id","type":"string","format":"uuid"}},{"name":"X-API-Key","in":"header","required":false,"schema":{"title":"X-Api-Key","type":"string"}}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignTargetActivityOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aurorasuite.ai/api-reference/campaigns/analytics.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.