{"_id":"5c4a3005dbeb250010b1beed","project":"56c35c56c0c4630d004e864c","version":{"_id":"56c35c56c0c4630d004e864f","project":"56c35c56c0c4630d004e864c","__v":8,"createdAt":"2016-02-16T17:28:54.864Z","releaseDate":"2016-02-16T17:28:54.864Z","categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5"},"category":{"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T17:53:10.154Z","from_sync":false,"order":1,"slug":"buzz-api-reference","title":"Buzz API Reference"},"user":"56c39c05bc41330d009f25d7","__v":6,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-01-24T21:37:09.175Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"curl","code":"curl -X GET \"[host]/rest/bid_model_version\" -b cookies.txt -d '{\"bid_model_version_id\":1}'"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n    \"success\": true,\n    \"payload\": [\n        {\n            \"bid_model_version_id\": 1,\n            \"bid_model_id\": 2,\n            \"bid_model_version_name\": \"Version 1\",\n            \"manifest_s3_path\": \"s3://path/to/file/file.json\",\n            \"upload_status\": \"FAILED\",\n            \"account_id\": 1,\n            \"create_date\": \"2018-12-13 17:37:04\",\n            \"update_date\": \"2019-01-08 14:50:00\",\n            \"alternative_id\": null,\n            \"notes\": null,\n            \"active\": true,\n            \"buzz_key\": \"stinger\", \n            \"errors\": [\n                {\n                    \"type\": \"Read Error\",\n                    \"error_message\": \"failed to read manifest file from S3\",\n                    \"file\": \"some_file_name\",\n                    \"first_row\": null,\n                    \"region\": \"eu-west-1\"          \n                }\n            ],\n            \"bid_model_version_key\": \"stinger-2-1\"\n        }\n    ]\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"5c4a2eda20e9ed001964471e","ref":"","in":"body","required":false,"desc":"Unique identifier of the Bid Model Version to be updated","default":"","type":"int","name":"bid_model_version_id"},{"_id":"5c4a2dbcd7f7840136ff38c6","ref":"","in":"body","required":false,"desc":"Unique ID of the Bid Model this version is associated with.","default":"","type":"int","name":"bid_model_id"},{"_id":"56c39b11e1e4190d003429b7","ref":"","in":"body","required":true,"desc":"Name of the Bid Model Version, e.g. \"Model 17.x.3\"","default":"","type":"string","name":"bid_model_version_name"},{"_id":"56c38f9c2d97560d00e23cb9","ref":"","in":"body","required":false,"desc":"An alternative id to lookup the  Line Item, if desired","default":"","type":"string","name":"alternative_id"},{"_id":"5c4a23d68e4d0302305d31ab","ref":"","in":"body","required":false,"desc":"Path to the file on S3","default":"","type":"string","name":"manifest_s3_path"},{"_id":"5c4a3005dbeb250010b1beee","ref":"","in":"body","required":false,"desc":"The current status of the version.","default":"","type":"string","name":"upload_status"},{"_id":"56c39b11e1e4190d003429b2","ref":"","in":"body","required":false,"desc":"Notes, up to 255 chars","default":"","type":"string","name":"notes"},{"_id":"56c39b11e1e4190d003429b1","ref":"","in":"body","required":false,"desc":"Is it active?","default":"1","type":"boolean","name":"active"}],"url":"/rest/bid_model_version"},"isReference":true,"order":36,"body":"[block:api-header]\n{\n  \"title\": \"Interpreting the Output\"\n}\n[/block]\nThe field `bid_model_version_key` is for internal use and can be ignored.\n\nThe `upload_status` field has the following values:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"`upload_status` value\",\n    \"h-1\": \"Meaning\",\n    \"0-0\": \"`NEW`\",\n    \"0-1\": \"Bid Model Version has not yet been processed\",\n    \"1-0\": \"`AVAILABLE `\",\n    \"2-0\": \"`PENDING`\",\n    \"3-0\": \"`LIVE`\",\n    \"4-0\": \"`FAILED`\",\n    \"4-1\": \"There was an error processing the Bid Model Version and it is not live. See the `errors` field for more details.\",\n    \"3-1\": \"The Bid Model Version is in production and will be used to bid when either the `current_version` field of the Bid Model is set to this version, OR when the `current_version` is null and this is the most recent version.\",\n    \"2-1\": \"The Bid Model Version is in the process of being processed.\",\n    \"1-1\": \"Bid Model Version was previously loaded and validated.  It is not currently live, but can be made live at any time.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\nThe `errors` field is a list of objects describing any errors discovered during processing the upload. The table below lists the potential errors.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"1\",\n    \"5-0\": \"6\",\n    \"4-0\": \"5\",\n    \"3-0\": \"4\",\n    \"2-0\": \"3\",\n    \"1-0\": \"2\",\n    \"0-1\": \"`MANIFEST_ERROR`\",\n    \"0-2\": \"The manifest file is invalid. Fix and re-upload the manifest file, then re-submit the version (click the green refresh icon).\",\n    \"1-1\": \"`PREDICTION_ERROR`\",\n    \"1-2\": \"The prediction file contains incorrect columns, or does not match the spec in the manifest file. Fix and re-upload the offending file, then re-submit the version.\",\n    \"2-1\": \"`VALIDATION_ERROR`\",\n    \"2-2\": \"One or more columns in the prediction files is invalid. The error message will tell you which column was invalid and why, and will list the first invalid file/row it encountered. Fix and re-upload the predictions, then re-submit the version.\",\n    \"3-1\": \"`WRITE_ERROR`\",\n    \"3-2\": \"The system was unable to load the model into the serving system. This is usually transient and you can try re-submitting the version.\",\n    \"4-1\": \"`READ_ERROR`\",\n    \"4-2\": \"The system was unable to read the manifest or prediction files from S3.  Check that you entered the paths correctly and re-submit.  If the paths are correct and you are still getting this error, contact support.\",\n    \"5-1\": \"`SYSTEM_ERROR`\",\n    \"5-2\": \"This is a catch-all **exception** for non-specific errors.  Contact support if you encounter this.\",\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Error Name\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","excerpt":"","slug":"bid-model-versions-get","type":"endpoint","title":"bid_model_version"}

getbid_model_version


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

bid_model_version_id:
integer
Unique identifier of the Bid Model Version to be updated
bid_model_id:
integer
Unique ID of the Bid Model this version is associated with.
bid_model_version_name:
required
string
Name of the Bid Model Version, e.g. "Model 17.x.3"
alternative_id:
string
An alternative id to lookup the Line Item, if desired
manifest_s3_path:
string
Path to the file on S3
upload_status:
string
The current status of the version.
notes:
string
Notes, up to 255 chars
active:
boolean1
Is it active?

Examples


Result Format


Documentation

[block:api-header] { "title": "Interpreting the Output" } [/block] The field `bid_model_version_key` is for internal use and can be ignored. The `upload_status` field has the following values: [block:parameters] { "data": { "h-0": "`upload_status` value", "h-1": "Meaning", "0-0": "`NEW`", "0-1": "Bid Model Version has not yet been processed", "1-0": "`AVAILABLE `", "2-0": "`PENDING`", "3-0": "`LIVE`", "4-0": "`FAILED`", "4-1": "There was an error processing the Bid Model Version and it is not live. See the `errors` field for more details.", "3-1": "The Bid Model Version is in production and will be used to bid when either the `current_version` field of the Bid Model is set to this version, OR when the `current_version` is null and this is the most recent version.", "2-1": "The Bid Model Version is in the process of being processed.", "1-1": "Bid Model Version was previously loaded and validated. It is not currently live, but can be made live at any time." }, "cols": 2, "rows": 5 } [/block] The `errors` field is a list of objects describing any errors discovered during processing the upload. The table below lists the potential errors. [block:parameters] { "data": { "0-0": "1", "5-0": "6", "4-0": "5", "3-0": "4", "2-0": "3", "1-0": "2", "0-1": "`MANIFEST_ERROR`", "0-2": "The manifest file is invalid. Fix and re-upload the manifest file, then re-submit the version (click the green refresh icon).", "1-1": "`PREDICTION_ERROR`", "1-2": "The prediction file contains incorrect columns, or does not match the spec in the manifest file. Fix and re-upload the offending file, then re-submit the version.", "2-1": "`VALIDATION_ERROR`", "2-2": "One or more columns in the prediction files is invalid. The error message will tell you which column was invalid and why, and will list the first invalid file/row it encountered. Fix and re-upload the predictions, then re-submit the version.", "3-1": "`WRITE_ERROR`", "3-2": "The system was unable to load the model into the serving system. This is usually transient and you can try re-submitting the version.", "4-1": "`READ_ERROR`", "4-2": "The system was unable to read the manifest or prediction files from S3. Check that you entered the paths correctly and re-submit. If the paths are correct and you are still getting this error, contact support.", "5-1": "`SYSTEM_ERROR`", "5-2": "This is a catch-all **exception** for non-specific errors. Contact support if you encounter this.", "h-0": "Error Code", "h-1": "Error Name", "h-2": "Description" }, "cols": 3, "rows": 6 } [/block]