# Brand monitor Human Guide

## What This Is For
Track brand mentions, analyze sentiment, and discover PR opportunities using the Brand.dev API. It gives the agent a clearer input/output frame for brand and messaging: what context to ask for, what decisions to make, and what usable artifact to return.

Use this as a human-readable version of the Brand monitor agent skill. It is meant for marketers, operators, founders, and other non-coders who want the workflow without reading agent-specific implementation instructions.

## When To Use This
- Use this when you need a repeatable process for brand monitor.
- Use this when the task needs judgment, examples, constraints, or a clear output format rather than a one-off prompt.
- Use this when you want to hand an AI assistant enough context to produce a usable marketing artifact.

## When Not To Use This
- Do not use this when you only need a quick factual answer.
- Do not use this when the work depends on private data you cannot share with the assistant.
- Do not use this as a replacement for legal, compliance, financial, or medical review.

## What You Need Before Starting
- The goal or business outcome you want.
- The audience, customer segment, or market context.
- Any source material the assistant should respect, such as notes, briefs, examples, URLs, or brand guidance.
- Constraints such as tone, length, channel, deadline, region, or approval requirements.
- A clear definition of what a good final answer should look like.

## Step-By-Step Workflow
1. State the job clearly: "Use the Brand monitor guide to help me with..."
2. Add context: audience, goal, offer, channel, source material, and constraints.
3. Ask the assistant to identify missing inputs before producing the final output.
4. Have the assistant follow the skill-specific guidance below.
5. Review the result against the final checklist and ask for revisions where needed.

## Skill-Specific Guidance
- `description`: Brand description
- `industry`: Industry classification
- `social_profiles`: Links to social media
- `colors`: Brand color palette
- `employees_range`: Company size estimate
- Partner and sponsor visibility
- Event coverage and media placements
- Counterfeit product listings
- **Positive** (> 0.3): Praise, recommendations, positive reviews
- **Neutral** (-0.3 to 0.3): Factual mentions, news coverage
- **Negative** (< -0.3): Complaints, criticism, negative reviews
- Search mentions for your brand and each competitor

## Decision Points And Nuance
The original skill emphasizes: Prerequisites, API Base, Brand Search, Endpoint, Parameters, Example curl, Response Parsing, Brand Info Lookup, Response Fields, Logo Detection.

Use these questions to steer the work:
- What is the intended audience or buyer?
- What source material must be preserved?
- What should the assistant optimize for: clarity, persuasion, accuracy, speed, creativity, or conversion?
- What examples represent the desired quality bar?
- What should the assistant avoid?

## Common Mistakes
- Identify sources where competitors get mentioned but you do not
- Exclude your own domain to avoid self-mentions

## Copy-And-Paste Prompt
```text
Use the Brand monitor human guide.

My goal:
[Describe the business outcome]

Audience:
[Describe who this is for]

Context and source material:
[Paste notes, examples, links, or existing copy]

Constraints:
[Tone, length, channel, timeline, must-include items, must-avoid items]

Before producing the final output, ask me for any missing information that would materially improve the result.
```

## Final Checklist
- [ ] The output matches the original goal.
- [ ] The audience and context are reflected in the answer.
- [ ] Important constraints and source material were preserved.
- [ ] The assistant made the relevant decisions explicit.
- [ ] The final artifact is ready to use, review, or hand to the next person.

## Source
This guide was generated from the openclaudia/openclaudia-skills skill entry for `brand-monitor`.

## Source Skill Notes
These notes preserve the nuance from the original skill. Use them as supporting reference when the workflow above feels too generic.

# Brand Monitor

Track brand mentions, analyze sentiment, and discover PR opportunities using the Brand.dev API.

## Prerequisites

Requires `BRANDDEV_API_KEY` set in `.env`, `.env.local`, or `~/.claude/.env.global`.

```bash
echo "BRANDDEV_API_KEY is ${BRANDDEV_API_KEY:+set}"
```

If the key is not set, instruct the user:
> You need a Brand.dev API key. Get one at https://brand.dev/
> Then add `BRANDDEV_API_KEY=your_key` to your `.env` file.

## API Base

All requests go to `https://api.brand.dev/v1/` with the header `Authorization: Bearer {BRANDDEV_API_KEY}`.

---

## 1. Brand Search

Search for mentions of a brand name across the web.

### Endpoint

```
GET https://api.brand.dev/v1/brand/search
```

### Parameters

| Param | Type | Description |
|-------|------|-------------|
| `query` | string | Brand name or phrase to search |
| `limit` | int | Number of results (default 20, max 100) |
| `offset` | int | Pagination offset |
| `sort` | string | `relevance` or `date` |
| `from_date` | string | Start date (YYYY-MM-DD) |
| `to_date` | string | End date (YYYY-MM-DD) |

### Example curl

```bash
curl -s -H "Authorization: Bearer ${BRANDDEV_API_KEY}" \
  "https://api.brand.dev/v1/brand/search?query=YourBrand&limit=20&sort=date"
```

### Response Parsing

```bash
curl -s -H "Authorization: Bearer ${BRANDDEV_API_KEY}" \
  "https://api.brand.dev/v1/brand/search?query=YourBrand&limit=20" \
  | python3 -c "
import json, sys
data = json.load(sys.stdin)
for m in data.get('results', []):
    print(f\"Source: {m.get('source','')}  |  Title: {m.get('title','')}  |  Sentiment: {m.get('sentiment','n/a')}  |  Date: {m.get('published_at','')}\")
    print(f\"  URL: {m.get('url','')}\")
    print()
"
```

---

## 2. Brand Info Lookup

Get structured brand information for any company or product.

### Endpoint

```
GET https://api.brand.dev/v1/brand/info
```

### Parameters

| Param | Type | Description |