{"openapi":"3.0.3","info":{"title":"Identity Network Resources","version":"2.0.0","description":"Buzz API v2"},"paths":{"/id-mapping/overview":{"get":{"operationId":"id_mapping_overview_retrieve","description":"Provides aggregated metrics for ID Mapping, including Inventory Match Rate and ID Usage metrics. Requires `platform`, `start_time`, and `end_time` query parameters.","summary":"Get ID Mapping Overview","parameters":[{"in":"query","name":"end_time","schema":{"type":"string","format":"date"},"description":"End date in YYYY-MM-DD format.","required":true},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Platform identifier.","required":true},{"in":"query","name":"start_time","schema":{"type":"string","format":"date"},"description":"Start date in YYYY-MM-DD format.","required":true}],"tags":["Identity Network"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"inventory_match_rate":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","enum":["Total Match Rate"]},"metrics":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"metric":{"type":"number"}}}}}},{"type":"object","properties":{"name":{"type":"string","enum":["Core"]},"metrics":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"metric":{"type":"number"}}}}}}]}},"id_usage":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"name":{"type":"string","enum":["1P Match Rate"]},"metrics":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"metric":{"type":"number"}}}}}},{"type":"object","properties":{"name":{"type":"string","enum":["2P Match Rate"]},"metrics":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"metric":{"type":"number"}}}}}}]}}}}}},"description":"ID Mapping overview response."},"400":{"description":"Invalid or missing query parameters."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden."},"500":{"description":"Internal server error."}}}},"/id-mapping/status":{"get":{"operationId":"id_mapping_status_retrieve","description":"Retrieve a paginated list of ID Mapping Status records from the Identity Network. Supports pagination, sorting, filtering, platform selection, searching, and showing only latest entries.","summary":"List ID Mapping Status records","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"Filter parameters based on FilterSchema format."},{"in":"query","name":"pagination","schema":{"type":"object","additionalProperties":{}},"description":"Pagination options: { page: number, per_page: number }"},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Platform identifier used for filtering data."},{"in":"query","name":"search","schema":{"type":"string"},"description":"Free-text search, following SearchSchema rules."},{"in":"query","name":"showLatest","schema":{"type":"boolean"},"description":"If true, returns only the most recent status entry per ID."},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting parameters based on SortSchema format."}],"tags":["Identity Network"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","required":["id_mapping_status","page","per_page","total","total_pages"],"properties":{"id_mapping_status":{"type":"array","items":{"type":"object","properties":{"id_display_name":{"type":"string"},"status_array":{"type":"string"},"failed_message":{"type":"string"},"total_records":{"type":"integer"},"total_match_rate":{"type":"number"},"received_at":{"type":"string","format":"date-time"},"status_updated_time":{"type":"string","format":"date-time"},"is_optout":{"type":"boolean"}}}},"page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"},"total_pages":{"type":"integer"}}}}},"description":"List of Id Mapping Status records."}}}},"/id-mapping/status/export":{"get":{"operationId":"id_mapping_status_export_retrieve","description":"Generates and downloads a CSV report representing the ID Mapping Status for entities in the Identity Network. Supports sorting, filtering, platform selection, and full-text search.","summary":"Export ID Mapping Status report as CSV","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"Filtering parameters following FilterSchema structure."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Platform identifier used for filtering."},{"in":"query","name":"search","schema":{"type":"string"},"description":"Free-text search string following SearchSchema rules."},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting parameters following SortSchema rules."}],"tags":["Identity Network"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"description":"Successfully generated CSV export of ID Mapping Status."}}}},"/id-permissions":{"get":{"operationId":"id_permissions_retrieve","description":"Retrieves a paginated list of Id Permissions with optional filtering, sorting, searching, platform selection, and party type selection. Supports advanced filtering using FilterSchema.","summary":"List Id Permissions","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"Advanced filtering using FilterSchema."},{"in":"query","name":"pagination","schema":{"type":"string"},"description":"Pagination mode used by the identity network."},{"in":"query","name":"party_type","schema":{"type":"string"},"description":"Filter by party type."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Filter data by platform."},{"in":"query","name":"search","schema":{"type":"string"},"description":"Search query using SearchSchema."},{"in":"query","name":"sort","schema":{"type":"string"},"description":"Sorting specification using SortSchema."}],"tags":["Identity Network"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"description":"Paginated list of Id Permissions."},"400":{"description":"Invalid filter, search, or sort parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Unexpected server error."}}}},"/id-permissions/download":{"get":{"operationId":"id_permissions_download_retrieve","description":"Provides a downloadable URL for exporting Id Permissions. Supports optional filtering by platform, party type, and advanced filters.","summary":"Download Id Permissions file","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"Advanced filtering using FilterSchema."},{"in":"query","name":"party_type","schema":{"type":"string"},"description":"Filter by party type."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Filter results by platform."}],"tags":["Identity Network"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"download_url":{"type":"string","format":"uri"}}}}},"description":""},"400":{"description":"Invalid filter or parameters."},"401":{"description":"Authentication required."},"403":{"description":"Permission denied."},"500":{"description":"Unexpected server error."}}}},"/id-permissions/id-usage":{"get":{"operationId":"id_permissions_id_usage_retrieve","description":"Returns identity permission usage metrics grouped by key name. Supports filtering by platform, party type, and advanced filters.","summary":"Retrieve Id Permissions usage metrics","parameters":[{"in":"query","name":"filter","schema":{"type":"string"},"description":"Advanced filtering using FilterSchema."},{"in":"query","name":"party_type","schema":{"type":"string"},"description":"Filter results by party type."},{"in":"query","name":"platform","schema":{"type":"string"},"description":"Filter results by platform."}],"tags":["Identity Network"],"security":[{"nestSessionAuth":[]},{"nestBasicAuth":[]}],"responses":{"200":{"description":"Id Permissions usage metrics."},"400":{"description":"Invalid filter or query parameter."},"401":{"description":"Authentication required."},"403":{"description":"Forbidden. You do not have permission to access this resource."},"500":{"description":"Unexpected server error."}}}}},"components":{"securitySchemes":{"nestBasicAuth":{"type":"http","scheme":"basic","description":"Form-based Basic Authentication"},"nestSessionAuth":{"type":"http","scheme":"basic","description":"Form-based Basic Authentication"}}},"x-explorer-enabled":false,"x-samples-languages":["curl","node","ruby","javascript","python","php","java"],"servers":[{"url":"https://{buzz_key}.api.beeswax.com/rest/v2","variables":{"buzz_key":{"default":"stingersbx","description":"Unique customer ID assigned by the Beeswax"}}}],"x-readme":{"proxy-enabled":true}}