\n
\n\nTop-level fields
\n\nTop-level fields:\n\n| Field | Meaning |\n| --- | --- |\n| `countries` | Country breakdown keyed by country name. |\n| `global_earnings` | Total earnings across all included countries. |\n| `global_spend` | Total spend across all included countries. |\n| `global_amz_spend` | Total Amazon Ads spend across all included countries. |\n| `global_ad_sales` | Total ad-attributed sales across all included countries. |\n| `converted_currency` | Currency used for converted values in the response. |\n| `start_date` | The start date the returned data covers. |\n| `end_date` | The end date the returned data covers. |\n\n
", "summary": "List Amazon Attribution performance stats for an account", "parameters": [{"in": "query", "name": "account_id", "schema": {"type": "string"}, "description": "Account UUID associated with the API key.", "required": true}, {"in": "query", "name": "api_key", "schema": {"type": "string"}, "description": "Your unique API key.", "required": true}, {"in": "query", "name": "breakdown", "schema": {"type": "string", "enum": ["daily", "monthly"]}, "description": "Optional granularity: `daily` or `monthly`. When omitted, the standard non-breakdown response is returned. When active, table_data is keyed by YYYY-MM-DD or YYYY-MM."}, {"in": "query", "name": "countries", "schema": {"type": "string"}, "description": "Optional comma-separated marketplace/country filter. Use country codes like US, UK (or GB), DE, FR, ES, IT, NL, JP, IN, CA, BR, MX, AU, BE, IE, AE, SA, SE, PL, or special values Facebook, Other. Marketplace names (for example Amazon.com, Amazon.co.uk) are also accepted and normalized. Empty value (countries=) means all marketplaces."}, {"in": "query", "name": "currency", "schema": {"type": "string"}, "description": "Optional 3-letter currency code for response values, for example USD, EUR, or GBP."}, {"in": "query", "name": "end_date", "schema": {"type": "string", "format": "date"}, "description": "End date (YYYY-MM-DD). Must be within 365 days of start_date.", "required": true}, {"in": "query", "name": "fixed_range_selection", "schema": {"type": "string", "enum": ["Last 30 days", "Last 7 days", "Last 90 days", "Last Month", "Last Week", "Last Year", "This Month", "This Week", "This Year", "Today", "Yesterday"]}, "description": "Optional range shortcut."}, {"in": "query", "name": "start_date", "schema": {"type": "string", "format": "date"}, "description": "Start date (YYYY-MM-DD). The requested date range cannot exceed 365 days.", "required": true}], "tags": ["API"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CountryStatsResponse"}, "examples": {"ExampleResponse": {"value": {"countries": {"United States": {"original": 463.51, "converted": 463.51, "original_currency": "USD", "converted_currency": "USD", "original_spend": 121.3, "converted_spend": 121.3, "converted_amz_spend": 95.0, "converted_ad_sales": 214.8}, "United Kingdom": {"original": 198.23, "converted": 252.14, "original_currency": "GBP", "converted_currency": "USD", "original_spend": 48.1, "converted_spend": 61.2, "converted_amz_spend": 42.7, "converted_ad_sales": 96.4}}, "global_earnings": 715.65, "global_spend": 182.5, "global_amz_spend": 137.7, "global_ad_sales": 311.2, "start_date": "2025-02-01", "end_date": "2025-02-28"}, "summary": "Example response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"ValidationError": {"value": {"error": "Invalid api_key format"}, "summary": "Validation error"}}}}, "description": "Validation error"}, "401": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"AuthenticationError": {"value": {"error": "api_key is invalid"}, "summary": "Authentication error"}}}}, "description": "Authentication error"}, "403": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"SubscriptionError": {"value": {"error": "User subscription is not valid (you need an active subscription to access the API). Login and update your subscription to regain API access."}, "summary": "Subscription error"}}}}, "description": "Subscription or access error"}, "429": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"RateLimitExceeded": {"value": {"error": "Rate limit exceeded. Maximum 20 requests per minute per API key, with at least 3 seconds between requests.", "limit": "20 requests per minute per API key; maximum 1 request every 3 seconds"}, "summary": "Rate limit exceeded"}}}}, "description": "Rate limit exceeded"}}}}, "/api/v1/JournalEventsAPI/": {"get": {"operationId": "JournalEventsAPI_retrieve", "description": "\nReturns all journal events belonging to the requested Publisher Champ account, ordered by event date (newest first).\n\nFull URL: `https://www.publisherchamp.com/api/v1/JournalEventsAPI/`\n\nThe `date` field is always returned in `YYYY-MM-DD` format. The `title` and `asin` fields identify the related book. Events that are not associated with a title return `null` for these fields.\n\n**cURL example**\n\n```bash\ncurl \"https://www.publisherchamp.com/api/v1/JournalEventsAPI/?api_key=Country row fields
\n\nEach item in `countries`:\n\n| Field | Meaning |\n| --- | --- |\n| `original` | Total earnings in the original marketplace currency. |\n| `converted` | Total earnings converted to the response currency. |\n| `original_currency` | Original currency for the marketplace or country. |\n| `converted_currency` | Currency used for converted values in the response. |\n| `original_spend` | Total spend in the original marketplace currency. |\n| `converted_spend` | Total spend converted to the response currency. |\n| `converted_amz_spend` | Amazon Ads spend converted to the response currency. |\n| `converted_ad_sales` | Ad-attributed sales converted to the response currency. |\n\n
\n\nTop-level fields
\n\nTop-level fields:\n\n| Field | Meaning |\n| --- | --- |\n| `table_data` | Ad performance breakdown keyed by ASIN or grouped title reference. |\n| `start_date` | The start date the returned data covers. |\n| `end_date` | The end date the returned data covers. |\n\n
", "summary": "List advertising performance stats for an account", "parameters": [{"in": "query", "name": "account_id", "schema": {"type": "string"}, "description": "Account UUID associated with the API key.", "required": true}, {"in": "query", "name": "api_key", "schema": {"type": "string"}, "description": "Your unique API key.", "required": true}, {"in": "query", "name": "breakdown", "schema": {"type": "string", "enum": ["daily", "monthly"]}, "description": "Optional granularity: `daily` or `monthly`. When omitted, the standard non-breakdown response is returned. When active, table_data is keyed by YYYY-MM-DD or YYYY-MM."}, {"in": "query", "name": "countries", "schema": {"type": "string"}, "description": "Optional comma-separated marketplace/country filter. Use country codes like US, UK (or GB), DE, FR, ES, IT, NL, JP, IN, CA, BR, MX, AU, BE, IE, AE, SA, SE, PL, or special values Facebook, BookBub. Marketplace names (for example Amazon.com, Amazon.co.uk) are also accepted and normalized. Empty value (countries=) means all marketplaces."}, {"in": "query", "name": "currency", "schema": {"type": "string"}, "description": "Optional 3-letter currency code for response values, for example USD, EUR, or GBP."}, {"in": "query", "name": "end_date", "schema": {"type": "string", "format": "date"}, "description": "End date (YYYY-MM-DD). Must be within 365 days of start_date.", "required": true}, {"in": "query", "name": "fixed_range_selection", "schema": {"type": "string", "enum": ["Last 30 days", "Last 7 days", "Last 90 days", "Last Month", "Last Week", "Last Year", "This Month", "This Week", "This Year", "Today", "Yesterday"]}, "description": "Optional range shortcut."}, {"in": "query", "name": "start_date", "schema": {"type": "string", "format": "date"}, "description": "Start date (YYYY-MM-DD). The requested date range cannot exceed 365 days.", "required": true}], "tags": ["API"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AdsMonitoringResponse"}, "examples": {"ExampleResponse": {"value": {"table_data": {"B000000001": {"number_of_ads": 3, "spend": 12.3, "amz_spend": 10.1, "impressions": 3200, "clicks": 95, "ctr": "2.97%", "cpc": 0.13, "orders": 6, "sales": 78.4, "acos": "15.69%", "kenp_read": 1400, "estimated_kenp_royalties": 8.25, "title": "Second Book", "tacos": "11.55%", "asin": "B000000001", "currency": "USD", "all_asins": ["B000000001", "B000000099"], "all_formats": ["EBook", "Paperback"], "actual_orders": 9, "reported_cr": "6%", "total_cr": "9.47%", "gross_revenue": 106.5, "net_revenue": 94.2, "roi": 765, "ads_roi": 757, "image": "Ad row fields
\n\nEach item in `table_data`:\n\n| Field | Meaning |\n| --- | --- |\n| `number_of_ads` | Number of ads associated with this book or grouped reference. |\n| `spend` | Total ad spend across included ad sources. |\n| `amz_spend` | Amazon Ads spend. |\n| `impressions` | Total ad impressions. |\n| `clicks` | Total ad clicks. |\n| `ctr` | Click-through rate. |\n| `cpc` | Average cost per click. |\n| `orders` | Orders reported by the ad platform. |\n| `sales` | Sales attributed to ads. |\n| `acos` | Advertising cost of sales. |\n| `kenp_read` | Kindle Unlimited pages read attributed to ads. |\n| `estimated_kenp_royalties` | Estimated royalties from ad-attributed Kindle Unlimited reads. |\n| `title` | Book title. |\n| `tacos` | Total advertising cost of sales. |\n| `asin` | Book ASIN or grouped identifier. |\n| `currency` | Currency used for monetary amounts in this row. |\n| `all_asins` | All ASINs associated with this grouped row. |\n| `all_formats` | All formats associated with this grouped row. |\n| `actual_orders` | Actual orders from the underlying sales data. |\n| `reported_cr` | Conversion rate reported by the ad platform. |\n| `total_cr` | Conversion rate based on actual orders. |\n| `gross_revenue` | Gross revenue before deducting ad spend. |\n| `net_revenue` | Revenue after deducting ad spend. |\n| `roi` | Overall return on investment percentage. |\n| `ads_roi` | Amazon Ads return on investment percentage. |\n| `image` | Rendered image HTML for the book cover. |\n![](\"https://example.com/covers/second-book.jpg\")
"}, "B000000002": {"number_of_ads": 5, "spend": 28.9, "amz_spend": 26.0, "impressions": 7600, "clicks": 210, "ctr": "2.76%", "cpc": 0.14, "orders": 11, "sales": 155.2, "acos": "18.62%", "kenp_read": 4200, "estimated_kenp_royalties": 16.75, "title": "Third Book", "tacos": "14.34%", "asin": "B000000002", "currency": "USD", "all_asins": ["B000000002"], "all_formats": ["EBook"], "actual_orders": 15, "reported_cr": "5%", "total_cr": "7.14%", "gross_revenue": 201.6, "net_revenue": 172.7, "roi": 597, "ads_roi": 561, "image": "![](\"https://example.com/covers/third-book.jpg\")
"}}, "start_date": "2025-02-01", "end_date": "2025-02-28"}, "summary": "Example response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"ValidationError": {"value": {"error": "Invalid api_key format"}, "summary": "Validation error"}}}}, "description": "Validation error"}, "401": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"AuthenticationError": {"value": {"error": "api_key is invalid"}, "summary": "Authentication error"}}}}, "description": "Authentication error"}, "403": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"SubscriptionError": {"value": {"error": "User subscription is not valid (you need an active subscription to access the API). Login and update your subscription to regain API access."}, "summary": "Subscription error"}}}}, "description": "Subscription or access error"}, "429": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"RateLimitExceeded": {"value": {"error": "Rate limit exceeded. Maximum 20 requests per minute per API key, with at least 3 seconds between requests.", "limit": "20 requests per minute per API key; maximum 1 request every 3 seconds"}, "summary": "Rate limit exceeded"}}}}, "description": "Rate limit exceeded"}}}}, "/api/v1/amazonAttributionAdTagsAPI/": {"post": {"operationId": "amazonAttributionAdTagsAPI_create", "description": "Returns Amazon Attribution ad tags for the requested account.\n\nFull URL: `https://www.publisherchamp.com/api/v1/amazonAttributionAdTagsAPI/`\n\nThis endpoint is `POST` and accepts JSON. Use `search_q` to search within `attribution_id`.\n\n\n
\n\nRequest fields
\n\n| Field | Meaning |\n| --- | --- |\n| `api_key` | Publisher Champ API key. |\n| `account_id` | Publisher Champ account UUID. |\n| `search_q` | Optional substring search applied to `attribution_id`. |\n| `page` | Optional page number. Defaults to `1`. |\n| `length` | Optional rows per page. Defaults to `100` and cannot exceed `100`. |\n\n
", "summary": "List Amazon Attribution ad tags for an account", "tags": ["API"], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AmazonAttributionAdTagRequest"}}, "application/x-www-form-urlencoded": {"schema": {"$ref": "#/components/schemas/AmazonAttributionAdTagRequest"}}, "multipart/form-data": {"schema": {"$ref": "#/components/schemas/AmazonAttributionAdTagRequest"}}}, "required": true}, "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AmazonAttributionAdTagsResponse"}, "examples": {"ExampleResponse": {"value": {"total_results": 1, "page": 1, "length": 100, "total_pages": 1, "table_data": [{"attribution_id": "United States - 1234567890 - 99887766", "tag": "https://amazon.com/dp/publisherchamp-20?maas=...."}]}, "summary": "Example response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"ValidationError": {"value": {"error": "Invalid api_key format"}, "summary": "Validation error"}}}}, "description": "Validation error"}, "401": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"AuthenticationError": {"value": {"error": "api_key is invalid"}, "summary": "Authentication error"}}}}, "description": "Authentication error"}, "403": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"SubscriptionError": {"value": {"error": "User subscription is not valid (you need an active subscription to access the API). Login and update your subscription to regain API access."}, "summary": "Subscription error"}}}}, "description": "Subscription or access error"}, "429": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"RateLimitExceeded": {"value": {"error": "Rate limit exceeded. Maximum 20 requests per minute per API key, with at least 3 seconds between requests.", "limit": "20 requests per minute per API key; maximum 1 request every 3 seconds"}, "summary": "Rate limit exceeded"}}}}, "description": "Rate limit exceeded"}}}}, "/api/v1/authorStatsAPI/": {"get": {"operationId": "authorStatsAPI_retrieve", "description": "Returns per-author breakdowns for the requested date range.\n\nFull URL: `https://www.publisherchamp.com/api/v1/authorStatsAPI/`\n\nResponse fields
\n\n| Field | Meaning |\n| --- | --- |\n| `total_results` | Total rows matching the request. |\n| `page` | Returned page number. |\n| `length` | Rows requested per page. |\n| `total_pages` | Total available pages for the requested length. |\n| `table_data` | List of matching Amazon Attribution ad tag rows. |\n| `attribution_id` | Amazon Attribution id. |\n| `tag` | Amazon Attribution ad tag. |\n\n
\n\nTop-level fields
\n\nTop-level fields:\n\n| Field | Meaning |\n| --- | --- |\n| `table_data` | Author breakdown keyed by author name. |\n| `start_date` | The start date the returned data covers. |\n| `end_date` | The end date the returned data covers. |\n\n
", "summary": "List author performance stats for an account", "parameters": [{"in": "query", "name": "account_id", "schema": {"type": "string"}, "description": "Account UUID associated with the API key.", "required": true}, {"in": "query", "name": "api_key", "schema": {"type": "string"}, "description": "Your unique API key.", "required": true}, {"in": "query", "name": "breakdown", "schema": {"type": "string", "enum": ["daily", "monthly"]}, "description": "Optional granularity: `daily` or `monthly`. When omitted, the standard non-breakdown response is returned. When active, table_data is keyed by YYYY-MM-DD or YYYY-MM."}, {"in": "query", "name": "currency", "schema": {"type": "string"}, "description": "Optional 3-letter currency code for response values, for example USD, EUR, or GBP."}, {"in": "query", "name": "end_date", "schema": {"type": "string", "format": "date"}, "description": "End date (YYYY-MM-DD). Must be within 365 days of start_date.", "required": true}, {"in": "query", "name": "fixed_range_selection", "schema": {"type": "string", "enum": ["Last 30 days", "Last 7 days", "Last 90 days", "Last Month", "Last Week", "Last Year", "This Month", "This Week", "This Year", "Today", "Yesterday"]}, "description": "Optional range shortcut."}, {"in": "query", "name": "start_date", "schema": {"type": "string", "format": "date"}, "description": "Start date (YYYY-MM-DD). The requested date range cannot exceed 365 days.", "required": true}], "tags": ["API"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AuthorStatsResponse"}, "examples": {"ExampleResponse": {"value": {"table_data": {"Jane Doe": {"Example Book": {"units_sold": 140, "free_units_sold": 12, "paid_units_sold": 128, "book_royalty": 120.0, "read_royalty": 15.5, "reads": 500, "asin": "B000000000", "currency": "USD", "external_royalty": 4.25, "book_title": "Example Book"}}, "John Smith": {"Book A": {"units_sold": 80, "free_units_sold": 5, "paid_units_sold": 75, "book_royalty": 70.0, "read_royalty": 6.8, "reads": 120, "asin": "B000000100", "currency": "USD", "external_royalty": 0, "book_title": "Book A"}, "Book B": {"units_sold": 40, "free_units_sold": 0, "paid_units_sold": 40, "book_royalty": 45.5, "read_royalty": 3.2, "reads": 90, "asin": "B000000101", "currency": "USD", "external_royalty": 2.1, "book_title": "Book B"}}}, "start_date": "2025-02-01", "end_date": "2025-02-28"}, "summary": "Example response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"ValidationError": {"value": {"error": "Invalid api_key format"}, "summary": "Validation error"}}}}, "description": "Validation error"}, "401": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"AuthenticationError": {"value": {"error": "api_key is invalid"}, "summary": "Authentication error"}}}}, "description": "Authentication error"}, "403": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"SubscriptionError": {"value": {"error": "User subscription is not valid (you need an active subscription to access the API). Login and update your subscription to regain API access."}, "summary": "Subscription error"}}}}, "description": "Subscription or access error"}, "429": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"RateLimitExceeded": {"value": {"error": "Rate limit exceeded. Maximum 20 requests per minute per API key, with at least 3 seconds between requests.", "limit": "20 requests per minute per API key; maximum 1 request every 3 seconds"}, "summary": "Rate limit exceeded"}}}}, "description": "Rate limit exceeded"}}}}, "/api/v1/bookStatsAPI/": {"get": {"operationId": "bookStatsAPI_retrieve", "description": "Returns per-book sales, royalties, reads, and spend for the requested date range.\n\nFull URL: `https://www.publisherchamp.com/api/v1/bookStatsAPI/`\n\nAuthor book row fields
\n\nEach book row under an author:\n\n| Field | Meaning |\n| --- | --- |\n| `units_sold` | Total units sold for this book under the author. |\n| `free_units_sold` | Number of free units sold or downloaded. |\n| `paid_units_sold` | Number of paid units sold. |\n| `book_royalty` | Royalties earned from book sales. |\n| `read_royalty` | Royalties earned from Kindle Unlimited reads. |\n| `reads` | Number of Kindle Unlimited page reads. |\n| `asin` | Book ASIN or internal grouped identifier. |\n| `currency` | Currency used for monetary amounts in this row. |\n| `external_royalty` | Royalty from external or manually added royalty sources. |\n| `book_title` | Book title. |\n\n
\n\nTop-level fields
\n\nTop-level fields:\n\n| Field | Meaning |\n| --- | --- |\n| `table_data` | List of book-level data rows. |\n| `start_date` | The start date the returned data covers. |\n| `end_date` | The end date the returned data covers. |\n\n
", "summary": "List book performance stats for an account", "parameters": [{"in": "query", "name": "account_id", "schema": {"type": "string"}, "description": "Account UUID associated with the API key.", "required": true}, {"in": "query", "name": "api_key", "schema": {"type": "string"}, "description": "Your unique API key.", "required": true}, {"in": "query", "name": "breakdown", "schema": {"type": "string", "enum": ["daily", "monthly"]}, "description": "Optional granularity: `daily` or `monthly`. When omitted, the standard non-breakdown response is returned. When active, table_data is keyed by YYYY-MM-DD or YYYY-MM."}, {"in": "query", "name": "countries", "schema": {"type": "string"}, "description": "Optional comma-separated marketplace/country filter. Use country codes like US, UK (or GB), DE, FR, ES, IT, NL, JP, IN, CA, BR, MX, AU, BE, IE, AE, SA, SE, PL, or special values Facebook, Other. Marketplace names (for example Amazon.com, Amazon.co.uk) are also accepted and normalized. Empty value (countries=) means all marketplaces."}, {"in": "query", "name": "currency", "schema": {"type": "string"}, "description": "Optional 3-letter currency code for response values, for example USD, EUR, or GBP."}, {"in": "query", "name": "end_date", "schema": {"type": "string", "format": "date"}, "description": "End date (YYYY-MM-DD). Must be within 365 days of start_date.", "required": true}, {"in": "query", "name": "fixed_range_selection", "schema": {"type": "string", "enum": ["Last 30 days", "Last 7 days", "Last 90 days", "Last Month", "Last Week", "Last Year", "This Month", "This Week", "This Year", "Today", "Yesterday"]}, "description": "Optional range shortcut."}, {"in": "query", "name": "include_country_breakdown", "schema": {"type": "boolean"}, "description": "Optional boolean. Set to true to include per-book country breakdowns in the response."}, {"in": "query", "name": "include_platform_breakdown", "schema": {"type": "boolean"}, "description": "Optional boolean. Set to true to include per-book platform breakdowns in the response."}, {"in": "query", "name": "start_date", "schema": {"type": "string", "format": "date"}, "description": "Start date (YYYY-MM-DD). The requested date range cannot exceed 365 days.", "required": true}], "tags": ["API"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BookStatsResponse"}, "examples": {"ExampleResponse": {"value": {"table_data": [{"image": "https://example.com/covers/example-book.jpg", "title": "Example Book", "asin": "B000000000", "currency": "USD", "ad_orders": 8, "paperbacks_sold": 14, "paperbacks_royalties": 18.4, "audiobooks_sold": 3, "audiobooks_royalties": 9.25, "pre_orders_sold": 5, "expanded_distribution_sold": 2, "expanded_distribution_royalties": 3.8, "hardcovers_sold": 4, "hardcovers_royalties": 11.0, "ebooks_paid_sold": 120, "ebooks_paid_royalties": 81.28, "ebooks_free_sold": 7, "total_reads": 2450, "spending": 28.75, "custom_expenses": 4.0, "amz_ad_spend": 18.5, "fb_ad_spend": 6.25, "gross_royalty": 123.45, "total_read_royalty": 21.22, "net_royalty": 94.7, "published_date": "2024-06-15", "full_reads": 12, "all_asins": ["B000000000", "B000000010"], "all_formats": ["EBook", "Paperback"], "all_series": ["#1 in Example Series", "#1 in Example Series"], "ad_clicks": 42, "fb_clicks": 10, "amz_clicks": 32, "clicks": 55, "country_breakdown": {"US": {"read_royalty": 12.52, "book_royalty": 70.11}, "UK": {"read_royalty": 8.7, "book_royalty": 32.12}}, "platform_breakdown": {"Amazon": 92.5, "Shopify": 18.73, "Apple Books": 12.22}}, {"image": "https://example.com/covers/second-book.jpg", "title": "Second Book", "asin": "B000000001", "currency": "USD", "ad_orders": 3, "paperbacks_sold": 6, "paperbacks_royalties": 7.8, "audiobooks_sold": 1, "audiobooks_royalties": 3.1, "pre_orders_sold": 2, "expanded_distribution_sold": 1, "expanded_distribution_royalties": 1.7, "hardcovers_sold": 0, "hardcovers_royalties": 0.0, "ebooks_paid_sold": 40, "ebooks_paid_royalties": 29.4, "ebooks_free_sold": 4, "total_reads": 600, "spending": 9.5, "custom_expenses": 1.5, "amz_ad_spend": 8.0, "fb_ad_spend": 0.0, "gross_royalty": 54.0, "total_read_royalty": 9.0, "net_royalty": 44.5, "published_date": "2023-11-03", "full_reads": 3, "all_asins": ["B000000001"], "all_formats": ["EBook"], "all_series": ["#1 in My Series", "#1 in My Series"], "ad_clicks": 18, "fb_clicks": 5, "amz_clicks": 13, "clicks": 21, "country_breakdown": {"US": {"read_royalty": 4.1, "book_royalty": 38.5}, "UK": {"read_royalty": 1.9, "book_royalty": 9.5}}, "platform_breakdown": {"Amazon": 44.5, "Barnes & Noble Press": 6.1, "Apple Books": 3.4}}], "start_date": "2025-01-01", "end_date": "2025-01-31"}, "summary": "Example response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"ValidationError": {"value": {"error": "Invalid api_key format"}, "summary": "Validation error"}}}}, "description": "Validation error"}, "401": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"AuthenticationError": {"value": {"error": "api_key is invalid"}, "summary": "Authentication error"}}}}, "description": "Authentication error"}, "403": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"SubscriptionError": {"value": {"error": "User subscription is not valid (you need an active subscription to access the API). Login and update your subscription to regain API access."}, "summary": "Subscription error"}}}}, "description": "Subscription or access error"}, "429": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"RateLimitExceeded": {"value": {"error": "Rate limit exceeded. Maximum 20 requests per minute per API key, with at least 3 seconds between requests.", "limit": "20 requests per minute per API key; maximum 1 request every 3 seconds"}, "summary": "Rate limit exceeded"}}}}, "description": "Rate limit exceeded"}}}}, "/api/v1/countryStatsAPI/": {"get": {"operationId": "countryStatsAPI_retrieve", "description": "Returns royalties and spend grouped by country or marketplace for the requested date range.\n\nFull URL: `https://www.publisherchamp.com/api/v1/countryStatsAPI/`\n\nBook row fields
\n\nEach item in `table_data`:\n\n| Field | Meaning |\n| --- | --- |\n| `image` | Book cover image URL. |\n| `title` | Book title. |\n| `asin` | The book's unique identifier. |\n| `currency` | Currency used for all monetary amounts in this row. |\n| `ad_orders` | Number of inorganic orders attributed to Amazon Ads. |\n| `paperbacks_sold` | Number of paperback units sold. |\n| `paperbacks_royalties` | Royalties earned from paperback sales. |\n| `audiobooks_sold` | Number of audiobook units sold. |\n| `audiobooks_royalties` | Royalties earned from audiobook sales. |\n| `pre_orders_sold` | Number of pre-order units sold. |\n| `expanded_distribution_sold` | Number of expanded distribution units sold. |\n| `expanded_distribution_royalties` | Royalties earned from expanded distribution sales. |\n| `hardcovers_sold` | Number of hardcover units sold. |\n| `hardcovers_royalties` | Royalties earned from hardcover sales. |\n| `ebooks_paid_sold` | Number of paid ebook units sold. |\n| `ebooks_paid_royalties` | Royalties earned from paid ebook sales. |\n| `ebooks_free_sold` | Number of free ebook units downloaded. |\n| `total_reads` | Number of Kindle Unlimited page reads. |\n| `spending` | Total spend across Amazon Ads, Facebook/Meta Ads, and custom external expenses. |\n| `custom_expenses` | Amount spent on manually added external expenses, separate from ad spend. |\n| `amz_ad_spend` | Amount spent on Amazon Ads only, excluding Facebook/Meta Ads and custom external expenses. |\n| `fb_ad_spend` | Amount spent on Facebook/Meta Ads only, excluding Amazon Ads and custom external expenses. |\n| `gross_royalty` | Total royalty before deducting spend. |\n| `total_read_royalty` | Total royalty earned from Kindle Unlimited reads. |\n| `net_royalty` | Net royalty after subtracting spend from gross royalty. |\n| `published_date` | Book publication date. |\n| `full_reads` | Estimated whole-book borrows: floor(total reads divided by KENPC). |\n| `all_asins` | All ASINs associated with this grouped title. |\n| `all_formats` | All formats associated with this grouped title. |\n| `all_series` | All series values associated with this grouped title. |\n| `ad_clicks` | Total ad clicks from Amazon Ads and Facebook/Meta Ads combined. |\n| `fb_clicks` | Number of Facebook/Meta ad clicks. |\n| `amz_clicks` | Number of Amazon ad clicks. |\n| `clicks` | Number of Smart Link clicks. |\n| `country_breakdown` | Optional breakdown by country or marketplace. |\n| `platform_breakdown` | Optional breakdown by publishing platform. |\n\n
\n\nTop-level fields
\n\nTop-level fields:\n\n| Field | Meaning |\n| --- | --- |\n| `countries` | Country breakdown keyed by country name. |\n| `global_earnings` | Total earnings across all included countries. |\n| `global_spend` | Total spend across all included countries. |\n| `global_amz_spend` | Total Amazon Ads spend across all included countries. |\n| `global_ad_sales` | Total ad-attributed sales across all included countries. |\n| `converted_currency` | Currency used for converted values in the response. |\n| `start_date` | The start date the returned data covers. |\n| `end_date` | The end date the returned data covers. |\n\n
", "summary": "List country performance stats for an account", "parameters": [{"in": "query", "name": "account_id", "schema": {"type": "string"}, "description": "Account UUID associated with the API key.", "required": true}, {"in": "query", "name": "api_key", "schema": {"type": "string"}, "description": "Your unique API key.", "required": true}, {"in": "query", "name": "countries", "schema": {"type": "string"}, "description": "Optional comma-separated marketplace/country filter. Use country codes like US, UK (or GB), DE, FR, ES, IT, NL, JP, IN, CA, BR, MX, AU, BE, IE, AE, SA, SE, PL, or special values Facebook, Other. Marketplace names (for example Amazon.com, Amazon.co.uk) are also accepted and normalized. Empty value (countries=) means all marketplaces."}, {"in": "query", "name": "currency", "schema": {"type": "string"}, "description": "Optional 3-letter currency code for response values, for example USD, EUR, or GBP."}, {"in": "query", "name": "end_date", "schema": {"type": "string", "format": "date"}, "description": "End date (YYYY-MM-DD). Must be within 365 days of start_date.", "required": true}, {"in": "query", "name": "fixed_range_selection", "schema": {"type": "string", "enum": ["Last 30 days", "Last 7 days", "Last 90 days", "Last Month", "Last Week", "Last Year", "This Month", "This Week", "This Year", "Today", "Yesterday"]}, "description": "Optional range shortcut."}, {"in": "query", "name": "start_date", "schema": {"type": "string", "format": "date"}, "description": "Start date (YYYY-MM-DD). The requested date range cannot exceed 365 days.", "required": true}], "tags": ["API"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/CountryStatsResponse"}, "examples": {"ExampleResponse": {"value": {"countries": {"United States": {"original": 463.51, "converted": 463.51, "original_currency": "USD", "converted_currency": "USD", "original_spend": 121.3, "converted_spend": 121.3, "converted_amz_spend": 95.0, "converted_ad_sales": 214.8}, "United Kingdom": {"original": 198.23, "converted": 252.14, "original_currency": "GBP", "converted_currency": "USD", "original_spend": 48.1, "converted_spend": 61.2, "converted_amz_spend": 42.7, "converted_ad_sales": 96.4}}, "global_earnings": 715.65, "global_spend": 182.5, "global_amz_spend": 137.7, "global_ad_sales": 311.2, "start_date": "2025-02-01", "end_date": "2025-02-28"}, "summary": "Example response"}}}}, "description": "Successful response"}, "400": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"ValidationError": {"value": {"error": "Invalid api_key format"}, "summary": "Validation error"}}}}, "description": "Validation error"}, "401": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"AuthenticationError": {"value": {"error": "api_key is invalid"}, "summary": "Authentication error"}}}}, "description": "Authentication error"}, "403": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"SubscriptionError": {"value": {"error": "User subscription is not valid (you need an active subscription to access the API). Login and update your subscription to regain API access."}, "summary": "Subscription error"}}}}, "description": "Subscription or access error"}, "429": {"content": {"application/json": {"schema": {"type": "object", "additionalProperties": {}}, "examples": {"RateLimitExceeded": {"value": {"error": "Rate limit exceeded. Maximum 20 requests per minute per API key, with at least 3 seconds between requests.", "limit": "20 requests per minute per API key; maximum 1 request every 3 seconds"}, "summary": "Rate limit exceeded"}}}}, "description": "Rate limit exceeded"}}}}, "/api/v1/listAccountsAPI/": {"get": {"operationId": "listAccountsAPI_retrieve", "description": "Returns the accounts this API key can access.\n\nFull URL: `https://www.publisherchamp.com/api/v1/listAccountsAPI/`\n\nCountry row fields
\n\nEach item in `countries`:\n\n| Field | Meaning |\n| --- | --- |\n| `original` | Total earnings in the original marketplace currency. |\n| `converted` | Total earnings converted to the response currency. |\n| `original_currency` | Original currency for the marketplace or country. |\n| `converted_currency` | Currency used for converted values in the response. |\n| `original_spend` | Total spend in the original marketplace currency. |\n| `converted_spend` | Total spend converted to the response currency. |\n| `converted_amz_spend` | Amazon Ads spend converted to the response currency. |\n| `converted_ad_sales` | Ad-attributed sales converted to the response currency. |\n\n
\n\nTop-level fields
\n\nTop-level fields:\n\n| Field | Meaning |\n| --- | --- |\n| `api_key` | The API key used for the request. |\n| `api_key_owner_email` | Email address of the API key owner. |\n| `accounts` | List of accounts accessible to this API key. |\n\n
", "summary": "List accounts available to an API key", "parameters": [{"in": "query", "name": "api_key", "schema": {"type": "string"}, "description": "Your unique API key.", "required": true}], "tags": ["API"], "responses": {"200": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ListAccountsResponse"}, "examples": {"ExampleResponse": {"value": {"api_key": "