রিপোর্ট পরিচালনা করুন

দুটি ভিন্ন সময়সীমায় ডেভেলপারদের কার্যকলাপ ও অর্জিত রাজস্বের তুলনা করুন, যাতে আপনি আপনার ডেভেলপারদের (এবং তাদের অ্যাপ্লিকেশনগুলোর) মধ্যে আপনার এপিআই প্যাকেজ ও প্রোডাক্টগুলোর পারফরম্যান্সের ঊর্ধ্বমুখী বা নিম্নমুখী প্রবণতা বিশ্লেষণ করতে পারেন।

রিপোর্টটির বিল করার মাস।

রিপোর্টিং স্তর। বৈধ মানগুলো হলো:

• বিস্তারিত : প্রতিটি লেনদেন আলাদা লাইনে প্রদর্শন করে এবং রেট প্ল্যানগুলো সঠিকভাবে প্রয়োগ করা হয়েছে কিনা তা যাচাই করার সুযোগ দেয়। এতে কোনো সারাংশ থাকে না।
• সারাংশ : প্রতিটি এপিআই পণ্য এবং ডেভেলপারের মোট রাজস্বের সারসংক্ষেপ প্রদান করে।
  

দ্রষ্টব্য : ক্লাসিক এজ UI-তে, API প্রোডাক্ট বান্ডেলগুলোকে API প্যাকেজ বলা হয়।

রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই প্রোডাক্ট বান্ডেলগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সমস্ত এপিআই প্রোডাক্ট বান্ডেল রিপোর্টে অন্তর্ভুক্ত করা হবে।

রিপোর্টটিতে প্রতিটি নির্বাচিত এপিআই প্রোডাক্ট বান্ডেলের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত রয়েছে।

সারাংশ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প'-এ 'প্রদর্শন করবেন না' বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) এপিআই প্রোডাক্ট বান্ডেলের তথ্য একত্রিত করে (এবং প্রতিটি এপিআই প্রোডাক্ট বান্ডেলের তথ্য আলাদাভাবে তালিকাভুক্ত করে না)।

রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই প্রোডাক্টগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সমস্ত এপিআই প্রোডাক্ট রিপোর্টে অন্তর্ভুক্ত করা হবে।

প্রতিবেদনে প্রতিটি নির্বাচিত এপিআই পণ্যের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত করা হয়েছে।

সারাংশ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প'-এ 'প্রদর্শন করবেন না ' বিকল্পটি নির্বাচন করতে পারেন। এক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) ডেভেলপারদের তথ্য একত্রিত করে (এবং প্রতিটি নির্বাচিত ডেভেলপারের তথ্য আলাদাভাবে তালিকাভুক্ত করে না)।

প্রতিবেদনে অন্তর্ভুক্ত করার জন্য কোম্পানিগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সব কোম্পানিই প্রতিবেদনে অন্তর্ভুক্ত হবে।

প্রতিবেদনে অন্তর্ভুক্ত করার জন্য রেট প্ল্যানসমূহ। নিম্নলিখিতগুলির মধ্যে একটি নির্বাচন করুন:

• সকল রেট প্ল্যান : রিপোর্টে সকল রেট প্ল্যান অন্তর্ভুক্ত করুন।
• স্ট্যান্ডার্ড রেট প্ল্যান : রিপোর্টে শুধুমাত্র স্ট্যান্ডার্ড রেট প্ল্যানগুলো অন্তর্ভুক্ত করুন।
• ডেভেলপার-নির্দিষ্ট রেট প্ল্যান : রিপোর্টে শুধুমাত্র ডেভেলপারদের প্ল্যান অন্তর্ভুক্ত করুন।

রিপোর্টটির বিল করার মাস।

রিপোর্টিং স্তর। বৈধ মানগুলো হলো:

• বিস্তারিত : প্রতিটি ব্যালেন্স রিফিল আলাদাভাবে প্রদর্শন করে এবং আপনার পেমেন্ট প্রসেসর থেকে প্রাপ্ত পেমেন্টের সাথে তা মিলিয়ে নেওয়ার সুযোগ দেয়।
• সারাংশ : প্রতিটি ডেভেলপারের মোট ব্যালেন্স রিফিলের সারসংক্ষেপ প্রদান করে।

প্রতিবেদনে অন্তর্ভুক্ত করার জন্য কোম্পানিগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সব কোম্পানিই প্রতিবেদনে অন্তর্ভুক্ত হবে।

প্রতিবেদনের জন্য তারিখের পরিসর। নিম্নলিখিতগুলির মধ্যে একটি নির্বাচন করুন:

• প্রিসেট : ড্রপ-ডাউন মেনু থেকে স্ট্যান্ডার্ড তারিখের পরিসরগুলোর (যেমন গত ক্যালেন্ডার মাস) মধ্যে একটি নির্বাচন করুন।
• কাস্টম : ক্যালেন্ডার পপ-আপ থেকে পরিসীমাটির জন্য একটি শুরুর তারিখ এবং একটি শেষের তারিখ বেছে নিন।

প্রতিবেদনের জন্য মুদ্রা। বৈধ মানগুলো হলো:

• স্থানীয় মুদ্রা : রিপোর্টের প্রতিটি লাইন প্রযোজ্য রেট প্ল্যান ব্যবহার করে প্রদর্শিত হয়। এর মানে হলো, ডেভেলপারদের যদি ভিন্ন ভিন্ন মুদ্রা ব্যবহার করে এমন প্ল্যান থাকে, তাহলে একটি রিপোর্টে একাধিক মুদ্রা থাকতে পারে।
• ইউরো : প্রতিবেদনে স্থানীয় মুদ্রার লেনদেনগুলো ইউরোতে রূপান্তর করে দেখানো হয়।
• যুক্তরাজ্য পাউন্ড : প্রতিবেদনে স্থানীয় মুদ্রার লেনদেনগুলো পাউন্ডে রূপান্তরিত করে দেখানো হয়।
• মার্কিন ডলার : প্রতিবেদনে স্থানীয় মুদ্রার লেনদেনগুলো ডলারে রূপান্তরিত করে দেখানো হয়েছে।

রিপোর্টিং স্তর। বৈধ মানগুলো হলো:

• বিস্তারিত : প্রতিটি লেনদেন আলাদা লাইনে দেখানো হয়। কোনো সারাংশ থাকে না।
• সারাংশ : আপনার নির্বাচিত প্যারামিটারগুলোর ওপর নির্ভর করে প্রতিটি এপিআই পণ্য এবং ডেভেলপারের মোট রাজস্বের সারসংক্ষেপ প্রদান করে।

দ্রষ্টব্য : ক্লাসিক এজ UI-তে, API প্রোডাক্ট বান্ডেলগুলোকে API প্যাকেজ বলা হয়।

রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই প্রোডাক্ট বান্ডেলগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সমস্ত এপিআই প্রোডাক্ট বান্ডেল রিপোর্টে অন্তর্ভুক্ত করা হবে।

রিপোর্টটিতে প্রতিটি নির্বাচিত এপিআই প্রোডাক্ট বান্ডেলের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত রয়েছে।

সারাংশ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প'-এ 'প্রদর্শন করবেন না' বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) এপিআই প্রোডাক্ট বান্ডেলের তথ্য একত্রিত করে (এবং প্রতিটি এপিআই প্রোডাক্ট বান্ডেলের তথ্য আলাদাভাবে তালিকাভুক্ত করে না)।

রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই প্রোডাক্টগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সমস্ত এপিআই প্রোডাক্ট রিপোর্টে অন্তর্ভুক্ত করা হবে।

প্রতিবেদনে প্রতিটি নির্বাচিত এপিআই পণ্যের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত করা হয়েছে।

সারাংশ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প'-এ 'প্রদর্শন করবেন না ' বিকল্পটি নির্বাচন করতে পারেন। এক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) ডেভেলপারদের তথ্য একত্রিত করে (এবং প্রতিটি নির্বাচিত ডেভেলপারের তথ্য আলাদাভাবে তালিকাভুক্ত করে না)।

প্রতিবেদনে অন্তর্ভুক্ত করার জন্য কোম্পানিগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সব কোম্পানিই প্রতিবেদনে অন্তর্ভুক্ত হবে।

সারাংশ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প' (Summary Display Options) বিভাগে 'প্রদর্শন করবেন না' (Do not display ) বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) কোম্পানির তথ্য একত্রিত করে (এবং প্রতিটি নির্বাচিত কোম্পানির তথ্য আলাদাভাবে তালিকাভুক্ত করে না)।

রিপোর্টে অন্তর্ভুক্ত করার জন্য অ্যাপ্লিকেশনগুলো নির্বাচন করুন। কোনোটি নির্বাচন করা না হলে, সমস্ত অ্যাপ্লিকেশনই রিপোর্টে অন্তর্ভুক্ত হবে।

প্রতিবেদনে প্রতিটি নির্বাচিত অ্যাপ্লিকেশনের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত করা হয়েছে।

সারাংশ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প' (Summary Display Options) বিভাগে 'প্রদর্শন করবেন না' (Do not display ) বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) অ্যাপ্লিকেশন জুড়ে তথ্য একত্রিত করে (এবং প্রতিটি নির্বাচিত অ্যাপ্লিকেশনের জন্য আলাদাভাবে তথ্য তালিকাভুক্ত করে না)।

রিপোর্টে কলামগুলো যে ক্রমে গ্রুপ করা হবে এবং দেখানো হবে। একটি সংখ্যা নির্বাচন করুন যা গ্রুপিং-এর মধ্যে সেই অংশের আপেক্ষিক ক্রম নির্দেশ করে (১ হলো প্রথম গ্রুপিং)। উদাহরণস্বরূপ, নিম্নলিখিতটি রিপোর্টটিকে প্রথমে প্যাকেজ, তারপর পণ্য, তারপর ডেভেলপার এবং সবশেষে অ্যাপ্লিকেশন অনুসারে গ্রুপ করে।

যদি আপনি কোনো বিভাগ প্রদর্শন করতে না চান, তাহলে ‘প্রদর্শন করবেন না’ নির্বাচন করুন, তারপর বাকি ক্ষেত্রগুলো ক্রমানুসারে নির্বাচন করুন। আপনি যখন কোনো একটি বিভাগের আপেক্ষিক ক্রম পরিবর্তন করেন অথবা রিপোর্টে কোনো বিভাগ প্রদর্শন না করার সিদ্ধান্ত নেন, তখন ক্রমটি স্বয়ংক্রিয়ভাবে আপডেট হয়ে যায়।

প্রতিবেদনের জন্য তারিখের পরিসর। নিম্নলিখিতগুলির মধ্যে একটি নির্বাচন করুন:

• প্রিসেট : ড্রপ-ডাউন মেনু থেকে স্ট্যান্ডার্ড তারিখের পরিসরগুলোর (যেমন গত ক্যালেন্ডার মাস) মধ্যে একটি নির্বাচন করুন।
• কাস্টম : ক্যালেন্ডার পপ-আপ থেকে পরিসীমাটির জন্য একটি শুরুর তারিখ এবং একটি শেষের তারিখ বেছে নিন।

রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই প্যাকেজসমূহ। নিম্নলিখিতগুলো থেকে যেকোনো একটি নির্বাচন করুন:

• সব : রিপোর্টে সমস্ত এপিআই প্যাকেজ অন্তর্ভুক্ত রয়েছে।
• নির্বাচিত : একটি তালিকা প্রদর্শন করে যেখান থেকে আপনি রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই প্যাকেজগুলো নির্বাচন করতে পারেন। আপনি যদি কোনো প্যাকেজ নির্বাচন না করেন, তাহলে সমস্ত প্যাকেজ রিপোর্টে অন্তর্ভুক্ত করা হবে।

রিপোর্টটিতে প্রতিটি নির্বাচিত এপিআই প্যাকেজের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত রয়েছে।

একটি সারসংক্ষেপ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প' (Summary Display Options) বিভাগে 'প্রদর্শন করবেন না (প্যাকেজ)' (Don't Display (Packages)) বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) এপিআই প্যাকেজ জুড়ে তথ্য একত্রিত করে (এবং প্রতিটি এপিআই প্যাকেজের জন্য আলাদাভাবে তথ্য তালিকাভুক্ত করে না)।

রিপোর্টে অন্তর্ভুক্ত করার জন্য এপিআই পণ্যগুলো। নিম্নলিখিতগুলো থেকে যেকোনো একটি নির্বাচন করুন:

• সব : রিপোর্টে সমস্ত এপিআই পণ্য অন্তর্ভুক্ত রয়েছে।
• নির্বাচিত : একটি তালিকা প্রদর্শন করে যেখান থেকে আপনি রিপোর্টে অন্তর্ভুক্ত করার জন্য পণ্য নির্বাচন করতে পারেন। আপনি যদি কোনো পণ্য নির্বাচন না করেন, তাহলে সমস্ত পণ্য রিপোর্টে অন্তর্ভুক্ত করা হবে।

প্রতিবেদনে প্রতিটি নির্বাচিত এপিআই পণ্যের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত করা হয়েছে।

একটি সারসংক্ষেপ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প' (Summary Display Options) বিভাগে 'প্রদর্শন করবেন না (পণ্য)' (Don't Display (Products)) বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) এপিআই (API) পণ্য জুড়ে তথ্য একত্রিত করে (এবং প্রতিটি এপিআই পণ্যের জন্য আলাদাভাবে তথ্য তালিকাভুক্ত করে না)।

প্রতিবেদনে অন্তর্ভুক্ত করার জন্য কোম্পানিগুলো। নিম্নলিখিতগুলো থেকে একটি নির্বাচন করুন:

• সব : প্রতিবেদনে অন্তর্ভুক্ত সকল কোম্পানি।
• নির্বাচিত : একটি তালিকা প্রদর্শন করে যেখান থেকে আপনি প্রতিবেদনে অন্তর্ভুক্ত করার জন্য কোম্পানিগুলো নির্বাচন করতে পারেন। আপনি যদি কোনো কোম্পানি নির্বাচন না করেন, তাহলে সব কোম্পানিই প্রতিবেদনে অন্তর্ভুক্ত হবে।

প্রতিবেদনে প্রতিটি নির্বাচিত কোম্পানির জন্য একটি আলাদা লাইন অন্তর্ভুক্ত করা হয়েছে।

একটি সারসংক্ষেপ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প' (Summary Display Options) বিভাগে 'প্রদর্শন করবেন না (কোম্পানি)' (Don't Display (Companies)) বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) কোম্পানির তথ্য একত্রিত করে (এবং প্রতিটি নির্বাচিত কোম্পানির তথ্য আলাদাভাবে তালিকাভুক্ত করে না)।

প্রতিবেদনে অন্তর্ভুক্ত করার জন্য আবেদনপত্রগুলো। নিম্নলিখিতগুলো থেকে একটি নির্বাচন করুন:

• সব : প্রতিবেদনে অন্তর্ভুক্ত সকল অ্যাপ্লিকেশন।
• নির্বাচিত : একটি তালিকা প্রদর্শন করে যেখান থেকে আপনি রিপোর্টে অন্তর্ভুক্ত করার জন্য অ্যাপ্লিকেশনগুলি নির্বাচন করতে পারেন। আপনি যদি কোনো অ্যাপ্লিকেশন নির্বাচন না করেন, তাহলে সমস্ত অ্যাপ্লিকেশন রিপোর্টে অন্তর্ভুক্ত করা হবে।

প্রতিবেদনে প্রতিটি নির্বাচিত অ্যাপ্লিকেশনের জন্য একটি আলাদা লাইন অন্তর্ভুক্ত করা হয়েছে।

একটি সারসংক্ষেপ প্রতিবেদনের জন্য, আপনি ঐচ্ছিকভাবে 'সারাংশ প্রদর্শন বিকল্প' (Summary Display Options) বিভাগে 'প্রদর্শন করবেন না (অ্যাপ্লিকেশন)' (Don't Display (Applications)) বিকল্পটি নির্বাচন করতে পারেন। এই ক্ষেত্রে, প্রতিবেদনটি সমস্ত (বা নির্বাচিত) অ্যাপ্লিকেশন জুড়ে তথ্য একত্রিত করে (এবং প্রতিটি নির্বাচিত অ্যাপ্লিকেশনের জন্য আলাদাভাবে তথ্য তালিকাভুক্ত করে না)।

প্রতিবেদনের জন্য মুদ্রা। বৈধ মানগুলো হলো:

• স্থানীয় মুদ্রা : রিপোর্টের প্রতিটি লাইন প্রযোজ্য রেট প্ল্যান ব্যবহার করে প্রদর্শিত হয়। এর মানে হলো, ডেভেলপারদের যদি ভিন্ন ভিন্ন মুদ্রা ব্যবহার করে এমন প্ল্যান থাকে, তাহলে একটি রিপোর্টে একাধিক মুদ্রা থাকতে পারে।
• ইউরো : রিপোর্টে স্থানীয় মুদ্রার লেনদেনগুলো ইউরোতে রূপান্তর করে দেখানো হয়।
• GPB : রিপোর্টে স্থানীয় মুদ্রার লেনদেনগুলো পাউন্ডে রূপান্তর করে দেখানো হয়।
• ইউএসডি : প্রতিবেদনে স্থানীয় মুদ্রার লেনদেনগুলো ডলারে রূপান্তর করে দেখানো হয়।

রিপোর্টে কলামগুলো যে ক্রমে গ্রুপ করা হবে এবং দেখানো হবে। একটি সংখ্যা নির্বাচন করুন যা গ্রুপিং-এর মধ্যে সেই অংশের আপেক্ষিক ক্রম নির্দেশ করে (১ হলো প্রথম গ্রুপিং)। উদাহরণস্বরূপ, নিম্নলিখিতটি রিপোর্টটিকে প্রথমে প্যাকেজ, তারপর পণ্য, তারপর ডেভেলপার এবং সবশেষে অ্যাপ্লিকেশন অনুসারে গ্রুপ করে।

যদি আপনি কোনো বিভাগ প্রদর্শন করতে না চান, তাহলে ‘প্রদর্শন করবেন না’ নির্বাচন করুন, তারপর বাকি ক্ষেত্রগুলো ক্রমানুসারে নির্বাচন করুন। আপনি যখন কোনো একটি বিভাগের আপেক্ষিক ক্রম পরিবর্তন করেন অথবা রিপোর্টে কোনো বিভাগ প্রদর্শন না করার সিদ্ধান্ত নেন, তখন ক্রমটি স্বয়ংক্রিয়ভাবে আপডেট হয়ে যায়।

লেনদেন সহ অ্যাপ্লিকেশন

লেনদেন সহ ডেভেলপাররা

লেনদেন সহ পণ্য

লেনদেন সহ এপিআই পণ্য বান্ডেল (বা এপিআই প্যাকেজ)

The name of the report.

A description of the report.

The criteria for configuring a report. See Criteria configuration options for further details.

The type of the report. The value can be one of the following:

• BILLING
• REVENUE
• VARIANCE
• PREPAID_BALANCE

ID and organization for a specific application to be included in the report. If this property is not specified, all applications are included in the report.

Note: This property is not valid for revenue reports.

Billing month for the report, such as JULY.

Note: This property is not valid for revenue reports.

Billing year for the report, such as 2015.

ID and organization for a specific currency to be included in the report. If this property is not specified, all supported currencies are included in the report.

Currency for the report. Valid values include:

• LOCAL . Each line of the report is displayed using the applicable rate plan. This means that there may be multiple currencies in one report if the developers have plans that use different currencies.
• EUR . Local currency transactions are converted and displayed in Euros.
• GPB . Local currency transactions are converted and displayed in United Kingdom pounds.
• USD . Local currency transactions are converted and displayed in United States dollars.

Developer ID (email address), and organization name for a specific developer to be included in the report. If this property is not specified, all developers are included in the report. For example:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

Note: This property applies only to revenue reports.

Custom attributes to include in the report, if defined for a developer. For example:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Note: Do not specify the predefined MINT_* and ADMIN_* attributes in the devCustomAttributes array.

Note: This property applies only to revenue, variance, and transaction activity reports.

Starting date of the report in UTC.

Order in which columns are grouped in the report. Valid values include:

• APPLICATION
• BALANCE
• DEVELOPER
• ORG
• PACKAGE
• PRODUCT
• RATEPLAN

ID of one or more API product bundles to include in the report. If this property is not specified, all API product bundles are included in the report.

Note: This property is not valid when viewing the transaction activity ( /transaction-search ).

ID and organization for a specific API product bundle to be included in the report. If this property is not specified, all API product bundles are included in the report. This property can be specified instead of the monetizationpackageIds property.

Note: This property is not valid when viewing the transaction activity ( /transaction-search ).

Note: This property applies only to variance reports.

Starting date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

Note: This property applies only to variance reports.

Ending date of a previous period in UTC. Used to create a report for a previous period for comparison against a current report.

ID and organization for a specific API product to be included in the report. If this property is not specified, all API products are included in the report. This property can be specified instead of the productIds property.

Note: This property is not valid when viewing the transaction activity ( /transaction-search ).

ID of one or more API products to include in the report. If this property is not specified, all API products are included in the report.

API product IDs should be specified as org-name@@@product-name . For example: "productIds": ["myorg@@@myproduct", "myorg@@@myproduct2"]

Pricing type of rate plan to be included in the report. Valid values include:

• REVSHARE . Revenue share plan.
• REVSHARE_RATECARD . Revenue share and rate card rate plan.
• RATECARD . Rate card plan.

If this property is not specified, rate plans of all pricing types are included in the report.

Type of rate plan to be included in the report. Valid values include:

• DEVELOPER . Developer rate plan.
• STANDARD . Standard rate plan.

If this property is not specified, both developer-specific and standard rate plans are included in the report.

Flag that specifies whether the report shows revenue share percentages. Valid values include:

• true . Show revenue share percentages.
• false . Do not show revenue share percentages.

Flag that specifies whether the report is a summary. Valid values include:

• true . Report is a summary.
• false . Report is not a summary.

Note: This property applies only to revenue reports.

Flag that specifies whether the report shows transaction level details. Valid values include:

• true . Show transaction-level details.
• false . Do not show transaction-level details.

Flag that specifies whether the report shows the type of each transaction. Valid values include:

• true . Show the type of each transaction.
• false . Do not show the type of each transaction.

Note: This property applies only to revenue, variance, and transaction activity reports.

End date of the report in UTC.

The report includes data collected up to the end of day before the date specified. Report data collected on the specified end date will be excluded from the report. If you want to expire a rate plan on December 31, 2016, for example, you should set the toDate value to 2017-01-01. In this case, the report will include report data up to the end of the day on December 31, 2016; report data on January 1, 2017 will be excluded.

Status of transactions to include in the report. Valid values include:

• SUCCESS . Successful transaction.
• DUPLICATE . Duplicate transaction. These transactions can be ignored. The data pipeline from the Apigee runtime to the rating server can sometimes generate duplicate transactions in order to be fault tolerant and monetization recognizes and marks them as duplicate.
• FAILED . Failed transaction. This status is triggered when the validation of a precondition fails. For example:
  • Rating attempted even though the developer has not purchased rate plan. This can occur if the Monetization Limits Check policy is not configured.
  • Quota is exceeded, but calls still continue. This can occur if the Monetization Limits Check policy is not configured.
  • Negative custom attribute value was sent for custom attribute-based plan.
• INVALID_TSC . Transaction is invalid. This status is triggered when the txProviderStatus runtime criteria does not match the success criteria specified at the API product bundle-level.
• REVIEW . Transactions requiring review. This status is triggered for flexible revenue share rate plans if the value falls within a revenue range that is not configured.

Custom transaction attributes to include in summary revenue reports. You must enable this feature in your organization. See Including custom transaction attributes in revenue summary reports .

Type of transactions to be included in the report. Valid values include:

• PURCHASE : Total number of transactions. Applicable to Revenue share plans only.
• CHARGE : Charge calculated based on rate card rate plan and the number of transactions during the usage reporting period which starts from the date the developer purchased the rate plan .
• REFUND : Refunds issued. See Post refunds .
• CREDIT : Credits issued. See Issuing credits .
• BALANCE : Balance remaining for prepaid accounts. See Manage prepaid account balances .
• SETUPFEES : Set up fees charged. See Configuring fees for a rate plan .
• TERMINATIONFEES : Early termination fees charged. See Configuring fees for a rate plan .
• RECURRINGFEES : Recurring fees charged. See Configuring fees for a rate plan using the API and When are recurring fees charged and bundle plans reset? .
• TRUEUP : Transactions that are used to readjust rated transactions. They are invoked when tax changes are made in the previous billing month.

If this property is not specified, all transaction types are included in the report.